-
Notifications
You must be signed in to change notification settings - Fork 7
/
README.Rmd
64 lines (52 loc) · 2.96 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rxode2
<!-- badges: start -->
[](https://github.com/nlmixr2/rxode2/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/nlmixr2/rxode2?branch=main)
[](https://cran.r-project.org/package=rxode2)
[](https://cran.r-project.org/package=rxode2)
[](https://cran.r-project.org/package=rxode2)
[](https://www.codefactor.io/repository/github/nlmixr2/rxode2)
<!-- badges: end -->
## Overview
**rxode2** is an R package for solving and simulating from ode-based
models. These models are convert the rxode2 mini-language to C and
create a compiled dll for fast solving. ODE solving using rxode2 has a
few key parts:
- `rxode2()` which creates the C code for fast ODE solving based on a
[simple syntax](https://nlmixr2.github.io/rxode2/articles/rxode2-syntax.html) related to Leibnitz notation.
- The event data, which can be:
- a `NONMEM` or `deSolve` [compatible data frame](https://nlmixr2.github.io/rxode2/articles/rxode2-event-types.html), or
- created with `et()` or `eventTable()` for [easy simulation of events](https://nlmixr2.github.io/rxode2/articles/rxode2-event-table.html)
- The data frame can be augmented by adding
[time-varying](https://nlmixr2.github.io/rxode2/articles/rxode2-covariates.html#time-varying-covariates)
or adding [individual covariates](https://nlmixr2.github.io/rxode2/articles/rxode2-covariates.html#individual-covariates) (`iCov=` as needed)
- `rxSolve()` which solves the system of equations using initial
conditions and parameters to make predictions
- With multiple subject data, [this may be
parallelized](https://nlmixr2.github.io/rxode2/articles/rxode2-speed.html).
- With single subject the [output data frame is adaptive](https://nlmixr2.github.io/rxode2/articles/rxode2-data-frame.html)
- Covariances and other metrics of uncertanty can be used to
[simulate while solving](https://nlmixr2.github.io/rxode2/articles/rxode2-sim-var.html)
## Installation
```{r child='man-roxygen/rmdhunks/rxode2-install-hunk.Rmd'}
```
# Illustrated Example
```{r child='man/rmdhunks/rxode2-intro-chunk.Rmd'}
```
# Related R Packages
```{r child='man-roxygen/rmdhunks/related-R-chunk.Rmd'}
```