Learn R Programming

RDarwin

Overview

RDarwin is an R package designed to facilitate the usage of pyDarwin with the Certara NLME pharmacometric modeling engine from the R command line. The Python package, pyDarwin, is a powerful tool for using machine learning algorithms for model selection.

RDarwin defines a structure for NLME-pyDarwin usage by providing a set of R functions that can be used to specify search options across observation, dosepoints, structural parameters, fixed effects (thetas), random effects (omegas), and covariate effects. Additionally, users may execute a pyDarwin search directly from R using the function run_pyDarwin() (supports both NLME and NONMEM modeling engines).

Installation

install.packages("Certara.RDarwin", 
  repos = c("https://certara.jfrog.io/artifactory/certara-cran-release-public/", 
  "https://cloud.r-project.org"), method = "libcurl")

*Note: Additional installation of pyDarwin and Certara's NLME-Engine used by RsNLME is required. * Request NLME-Engine.

Copy Link

Version

Install

install.packages('Certara.RDarwin')

Version

1.1.1

License

LGPL-3

Maintainer

James Craig

Last Published

February 25th, 2025

Functions in Certara.RDarwin (1.1.1)

create_ModelPD

Get the list of objects describing the PML models by set of PD parameters
InitialEstimate

Create an object of class InitialEstimate
Observation

Create an instance of Observation class.
create_ModelEmax

Get the list of objects describing the PML models by set of Emax parameters
Covariate

Create a new Covariate object and validate it
Dosepoint

Create a new Dosepoint object and validate it
list_Omegas

List Unique Omega Names
list_StParms

List Structural Parameters in the currrent PML set
add_StParm

Add Structural parameter into PML models Dosepoints
remove_Observation

Remove Observation from PML models
modify_StParm

Modify structural parameter in PML models set
modify_StParmCustom

Modify custom structural parameter in PML spaces
remove_StParm

Remove structural parameter from PML models
create_CustomSpace

Create a Custom Space
specify_SimParams

Specify engine parameters for model simulation
stop_pyDarwin

Stop pyDarwin Model Search
modify_Observation

Modify Observation class in PML models
pyDarwinOptionsPostprocess

Create pyDarwin Postprocess Options
list_Thetas

List Unique Theta Names
ObservationCustom

Create an instance of custom Observation class.
StParm

Create an instance of a Structural parameter.
Sigmas

Create an instance of Sigmas class.
modify_Dosepoint

Modify Dosepoint in PML models
specify_EngineParams

Specify engine parameters for model execution
remove_Covariate

Remove Covariate from PML models
add_Covariate

Add Covariate into PML models
output.CustomSpace

Output a Custom Space
modify_Omega

Modify Omega Parameters in PML Models
create_ModelPK

Get the list of objects describing the PML models by set of PK parameters
run_pyDarwin

Run pyDarwin Model Search
Omega

Create an Omega instance with validation
add_CustomSpace

Add a Custom Space
modify_Theta

Modify Theta Parameters in PML Models
pyDarwinOptionsGA

Create options for the Genetic Algorithm (GA) in pyDarwin.
list_Dosepoints

List Dosepoints in the current PML set
pyDarwinOptionsPSO

Create options for the Particle Swarm Optimization (PSO) in pyDarwin.
list_Observations

List Observations in the current PML set
pyDarwinOptionsPenalty

Create pyDarwin Penalty Options
write_ModelTemplateTokens

Prints NLME metamodel template file and token json file using given options, filepaths and data
create_pyDarwinOptions

Create pyDarwin Options
write_pyDarwinOptions

Write pyDarwin options to a JSON file.
pyDarwinOptionsGridAdapter

Grid Adapter Options for pyDarwin
Theta

Create a new Theta instance with validation.
Table

Class initializer for NLME tables
get_ModelTermsToMap

Get Model Terms to Map
list_Covariates

List Covariates in the currrent PML set