https://github.com/nlmixrdevelopment/RxODE

RxODE is an R package that facilitates easy simulations in R
https://github.com/nlmixrdevelopment/RxODE

Last synced: 4 months ago
JSON representation

RxODE is an R package that facilitates easy simulations in R

• Host: GitHub
• URL: https://github.com/nlmixrdevelopment/RxODE
• Owner: nlmixrdevelopment
• License: gpl-3.0
• Created: 2017-03-28T14:29:13.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-04-04T23:28:46.000Z (about 3 years ago)
• Last Synced: 2024-08-13T07:13:28.198Z (8 months ago)
• Language: R
• Homepage: https://nlmixrdevelopment.github.io/RxODE/
• Size: 229 MB
• Stars: 55
• Watchers: 6
• Forks: 14
• Open Issues: 24
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - nlmixrdevelopment/RxODE - RxODE is an R package that facilitates easy simulations in R (R)

README

        


```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# RxODE

[![R build status](https://github.com/nlmixrdevelopment/RxODE/workflows/R-CMD-check/badge.svg)](https://github.com/nlmixrdevelopment/RxODE/actions)

[![codecov.io](https://codecov.io/github/nlmixrdevelopment/RxODE/coverage.svg)](https://codecov.io/github/nlmixrdevelopment/RxODE?branch=master)

[![CRAN version](http://www.r-pkg.org/badges/version/RxODE)](https://cran.r-project.org/package=RxODE)

[![CRAN checks](https://cranchecks.info/badges/worst/RxODE)](https://cran.r-project.org/web/checks/check_results_RxODE.html)

[![CRAN total downloads](https://cranlogs.r-pkg.org/badges/grand-total/RxODE)](https://cran.r-project.org/package=RxODE)

[![CRAN total downloads](https://cranlogs.r-pkg.org/badges/RxODE)](https://cran.r-project.org/package=RxODE)

[![CodeFactor](https://www.codefactor.io/repository/github/nlmixrdevelopment/rxode/badge)](https://www.codefactor.io/repository/github/nlmixrdevelopment/rxode)

## Overview

**RxODE** is an R package for solving and simulating from ode-based

models. These models are convert the RxODE mini-language to C and

create a compiled dll for fast solving. ODE solving using RxODE has a

few key parts:

 - `RxODE()` which creates the C code for fast ODE solving based on a

   [simple syntax](https://nlmixrdevelopment.github.io/RxODE/articles/RxODE-syntax.html) related to Leibnitz notation.

 - The event data, which can be:

   - a `NONMEM` or `deSolve` [compatible data frame](https://nlmixrdevelopment.github.io/RxODE/articles/RxODE-event-types.html), or

   - created with `et()` or `EventTable()` for [easy simulation of events](https://nlmixrdevelopment.github.io/RxODE/articles/RxODE-event-table.html)

   - The data frame can be augmented by adding

     [time-varying](https://nlmixrdevelopment.github.io/RxODE/articles/RxODE-covariates.html#time-varying-covariates)

     or adding [individual covariates](https://nlmixrdevelopment.github.io/RxODE/articles/RxODE-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://nlmixrdevelopment.github.io/RxODE/articles/RxODE-speed.html).

   - With single subject the [output data frame is adaptive](https://nlmixrdevelopment.github.io/RxODE/articles/RxODE-data-frame.html)

   - Covariances and other metrics of uncertanty can be used to

     [simulate while solving](https://nlmixrdevelopment.github.io/RxODE/articles/RxODE-sim-var.html)

## Installation

```{r child='man-roxygen/rmdhunks/RxODE-install-hunk.Rmd'}

```

# Illustrated Example

```{r child='man/rmdhunks/RxODE-intro-chunk.Rmd'}

```

# Related R Packages

```{r child='man-roxygen/rmdhunks/related-R-chunk.Rmd'}

```