devel/README_MD_backup.md

In philipdelff/NMdata: Preparation, Checking and Post-Processing Data for PK/PD Modeling

NMdata

A fast R package for efficient data preparation, consistency-checking and post-processing in PK/PD modeling

Pharmacometrics and PK/PD modeling offers unique information for decision-making in several steps of drug development. However, the leg work in pharmacometrics remains technical, and this is a typical bottleneck for a pharmacometrician to contributing even more.

Creating data sets - and if you use Nonmem, reading the results data - can be tedious, and mistakes can lead to hours of frustration. NMdata provides useful tools (including automated checks) for these trivial tasks. The aim is to automate the book keeping and allow more time for the actual analysis.

A central design feature of NMdata is that all included tools require as little as possible about how the user works. Any functionality in the package can be used independently of the rest of the package, and NMdata is not intended to force you to change any habits or preferences. Instead, NMdata tries to fit in with how you (or your colleague who worked on the project before you) do things.

The data set creation tools in NMdata may be equally interesting to users of nlmixr or other proprietary software than Nonmem. However, many features of the package relates to the final organization and writing of data for Nonmem, and reading data from Nonmem after a model run.

The best place to browse information about the package is here. All documentation is of course included in the package itself too.

Prepare, check, and export data for NONMEM

On the data-generation side, functionality is provided for documentation of the datasets while generating them. Check out this vignette on the topic. There are functions for automatic checks of (some) data merges, handling and counting of exclusions flags, final preparations for ensuring readability in Nonmem, and ensuring traceability of datasets back to data generation scripts.

Automated and general reader of Nonmem results data

Reading the resulting data from Nonmem can require a few manual steps. Especially because all modelers seem to do things a little differently. NMscanData can return all data output ($TABLE) from Nonmem combined, and if wanted with additional columns and rows in input data. It's as simple as

results <- NMscanData("run001.lst")

Take a look at this vignette for more info on the Nonmem data reader.

How to install

NMdata is on CRAN, MRAN, and MPN. To install from the package archive you are already using, do:

install.packages("NMdata")
library(NMdata)

If your archive has not been updated since July 2021, you may not find NMdata that way. In that case you have two other options. You can explicitly select CRAN for the installation. Or if you should want a version that has not yet reached CRAN, installing from Github is easy too.

## Option 2: Install explicitly from CRAN
install.packages("NMdata",repos="https://cloud.r-project.org")
library(NMdata)

## Option 3: Install from github
library(remotes)
install_github("philipdelff/NMdata")
library(NMdata)

If you use the Github version, you may want to see the FAQ for how to install specific releases from Github (ensuring reproducibility).

Questions?

Check the FAQ, or ask on github

Issues?

The best way to report a bug or to request features is on github.

Code of Conduct

Please note that the patchwork project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

philipdelff/NMdata documentation built on March 5, 2025, 12:20 a.m.