Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mattfidler committed Sep 15, 2024
1 parent ea77976 commit e1d3e18
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 19 deletions.
28 changes: 21 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ knitr::opts_chunk$set(
# babelmixr2

<!-- badges: start -->
[![R-CMD-check](https://github.com/nlmixr2/babelmixr2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nlmixr2/babelmixr2/actions/workflows/R-CMD-check.yaml)
[![R-CMD-check](https://github.com/nlmixr2/babelmixr2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nlmixr2/babelmixr2/actions/workflows/R-CMD-check.yaml)
[![CRAN version](http://www.r-pkg.org/badges/version/babelmixr2)](https://cran.r-project.org/package=babelmixr2)
[![CRAN total downloads](https://cranlogs.r-pkg.org/badges/grand-total/babelmixr2)](https://cran.r-project.org/package=babelmixr2)
[![CRAN total downloads](https://cranlogs.r-pkg.org/badges/babelmixr2)](https://cran.r-project.org/package=babelmixr2)
Expand Down Expand Up @@ -55,14 +55,19 @@ Babelmixr2 can help you by:

- Running your nlmixr2 model in a commercial nonlinear mixed effects
modeling tool like [`NONMEM`](https://nlmixr2.github.io/babelmixr2/articles/running-nonmem.html) or `Monolix`

- Convert your [`NONMEM` model to a nlmixr2
model](https://nlmixr2.github.io/nonmem2rx/articles/convert-nlmixr2.html)
(in conjunction with `nonmem2rx`)


- Convert you [`Monolix` model to a nlmixr2
model](https://nlmixr2.github.io/nonmem2rx/articles/convert-nlmixr2.html)
(in conjunction with `monolix2rx`)

- Calculate scaling factors and automatically add initial conditions
based on non-compartmental analysis (using `PKNCA`)

- Perform Optimal design using nlmixr2 as an interface to `PopED`

## Monolix Setup

Expand All @@ -72,9 +77,10 @@ While not required, you can get/install the R 'lixoftConnectors' package in the
'lixoftConnectors' is available, R can run 'Monolix' directly instead of using a
command line.

## Example
## PKNCA Example

After installed, if you use the standard interface, you can obtain new initial estimates with PKNCA:
After installed, if you use the standard interface, you can obtain new
initial estimates with PKNCA:

```r
mod <-
Expand All @@ -84,13 +90,21 @@ mod <-
)
```

or, you can convert to Monolix with
## Monolix example

With babelmixr2 loaded, you can use `nlmixr2` to convert a nlmixr2
model to Monolix, run with monolix, and import back to nlmixr2 with
the following:

```r
mod <- nlmixr(nlmixrFun, nlmmixrData, est="monolix")
```

or, you can convert to NONMEM with
## NONMEM example

With babelmixr2 loadid you can use `nlmixr2` to convert a nlmixr2
model to NONMEM, run NONMEM and import back to nlmixr2 with the
following:

```r
mod <- nlmixr(nlmixrFun, nlmmixrData, est="nonmem")
Expand Down
37 changes: 25 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,23 @@ Otherwise you can always install from GitHub:

Babelmixr2 can help you by:

- Running your nlmixr2 model in a commercial nonlinear mixed effects
modeling tool like
[`NONMEM`](https://nlmixr2.github.io/babelmixr2/articles/running-nonmem.html)
or `Monolix`
- Running your nlmixr2 model in a commercial nonlinear mixed effects
modeling tool like
[`NONMEM`](https://nlmixr2.github.io/babelmixr2/articles/running-nonmem.html)
or `Monolix`

- Convert your [`NONMEM` model to a nlmixr2
model](https://nlmixr2.github.io/nonmem2rx/articles/convert-nlmixr2.html)
(in conjunction with `nonmem2rx`)
- Convert your [`NONMEM` model to a nlmixr2
model](https://nlmixr2.github.io/nonmem2rx/articles/convert-nlmixr2.html)
(in conjunction with `nonmem2rx`)

- Calculate scaling factors and automatically add initial conditions
based on non-compartmental analysis (using `PKNCA`)
- Convert you [`Monolix` model to a nlmixr2
model](https://nlmixr2.github.io/nonmem2rx/articles/convert-nlmixr2.html)
(in conjunction with `monolix2rx`)

- Calculate scaling factors and automatically add initial conditions
based on non-compartmental analysis (using `PKNCA`)

- Perform Optimal design using nlmixr2 as an interface to `PopED`

## Monolix Setup

Expand All @@ -66,7 +72,7 @@ in the ‘Monolix’ installation, as described at the following url
When ‘lixoftConnectors’ is available, R can run ‘Monolix’ directly
instead of using a command line.

## Example
## PKNCA Example

After installed, if you use the standard interface, you can obtain new
initial estimates with PKNCA:
Expand All @@ -79,13 +85,20 @@ mod <-
)
```

or, you can convert to Monolix with
## Monolix example

With babelmixr2 loaded, you can use `nlmixr2` to convert a nlmixr2 model
to Monolix, run with monolix, and import back to nlmixr2 with the
following:

``` r
mod <- nlmixr(nlmixrFun, nlmmixrData, est="monolix")
```

or, you can convert to NONMEM with
## NONMEM example

With babelmixr2 loadid you can use `nlmixr2` to convert a nlmixr2 model
to NONMEM, run NONMEM and import back to nlmixr2 with the following:

``` r
mod <- nlmixr(nlmixrFun, nlmmixrData, est="nonmem")
Expand Down

0 comments on commit e1d3e18

Please sign in to comment.