Get paths to example model and data files

Returns file paths to bundled example models and datasets. Called without arguments, lists available example names.

ferx_example(name = NULL)

Arguments

name: Name of the example (e.g. "warfarin"). If NULL, returns a character vector of available example names.

Value

If name is NULL, a character vector of available examples. Otherwise, a list with components:

model: Path to the .ferx model file
data: Path to the NONMEM-format CSV data file

Details

Available bundled examples:

warfarin: One-compartment oral PK (standard warfarin dataset)
warfarin_bloq: One-compartment oral with BLOQ observations (M3 method)
warfarin_iov: One-compartment oral with inter-occasion variability (kappa)
warfarin_block_omega: One-compartment oral with correlated random effects
warfarin_saem: One-compartment oral estimated with SAEM
warfarin_additive_eta: One-compartment oral with additive ETA on lag time
warfarin_logit_f: One-compartment oral with logit-normal bioavailability
warfarin_if: Two-compartment oral with conditional if/else covariate (WT)
two_cpt_iv: Two-compartment IV bolus
two_cpt_oral_cov: Two-compartment oral with continuous covariates (WT, CRCL)
three_cpt_iv: Three-compartment IV bolus
mm_oral: One-compartment oral with Michaelis-Menten elimination (ODE)

Call ferx_example() with no arguments to list all available names.

Examples

ferx_example()
#>  [1] "bioavailability"       "bioavailability_ode"   "mm_multistart"        
#>  [4] "mm_oral"               "three_cpt_iv"          "two_cpt_iv"           
#>  [7] "two_cpt_oral_cov"      "warfarin"              "warfarin_additive_eta"
#> [10] "warfarin_block_omega"  "warfarin_bloq"         "warfarin_if"          
#> [13] "warfarin_iov"          "warfarin_logit_f"      "warfarin_saem"        
#> [16] "warfarin_sde"         
ex <- ferx_example("warfarin")
ex$model
#> [1] "/home/runner/work/_temp/Library/ferx/examples/models/warfarin.ferx"
ex$data
#> [1] "/home/runner/work/_temp/Library/ferx/examples/data/warfarin.csv"