Skip to contents

Datasets and objects

Datasets

Datasets that were used in package examples

warfarin
Warfarin PKPD dataset
ds_covval
Warfarin covariate values dataset
parest
Warfarin population PK parameter estimates
data_pbc
Primary Biliary Cirrhosis (PBC) dataset

SimuRg objects

Examples of SimuRg objects

GCO
Generalized Control Object (GCO)
GFO
Generalized Fit Object (GFO)
GMO
Generalized Model Object (GMO)
GSI
Generalized Simulations Input (GSI)
GSO
Generalized Simulations Output (GSO)
gfo4cov
Warfarin PopPK model fitting output (4-covariate model)
gmo_pk1c
One-compartment PK generalized model object (GMO)
gsi_pk1c
Generalized simulations input (GSI) for one-compartment PK example

Functions

Model fit and building

Functions to perform model calibration and find optimal statistical, structural or covariate model

sg_fit()
Optimize model with Monolix or Simurg core fitter
sg_multistart()
Build multistart scenarios with varying initial values
sg_modbuild()
Build estimation model scenarios
sg_modcomp()
Returns dataframe with summary statistics for model comparison

Convertion

Functions to convert input, output or structural model files between different formats

sg_converter()
Convert Monolix project output to R objects
sg_translator()
Translate structural models between rxode2 and MLXTRAN syntax

Goodness-of-fit

Functions to access model goodness-of-fit

sg_parsum()
Extract parameter summary (theta, eta, SE, RSE, CI, CV, shrinkage)
sg_modbuild()
Build estimation model scenarios
sg_gof_obpr()
Observed vs predicted plot
sg_gof_res()
Create residual diagnostic plots
sg_gof_par_dist()
Plot distributions of individual parameters with optional theoretical density
sg_gof_res_dist()
Plot distribution or QQ-plot of residuals from NONMEM/Simurg run
sg_gof_par_cov()
Plot random effects or individual parameters vs covariates
sg_gof_tp()
Plot time profiles of observed and predicted values from GFO $SDTAB.

Simulations

Functions to perform simulations with the model

sg_sim()
Perform simulations from an rxode2 model
sg_sim_tp()
Time-profile plotting with optional summary bands

Analysis

Functions to perform simulation-based analysis of the model

sg_vpc_sim()
Perform simulations for VPC plot
sg_vpc_vis()
Visual Predictive Check (VPC) Function
sg_covsens_sim()
Covariate sensitivity analysis via simulation
sg_covsens_vis()
Visualisation of covariate sensitivity analysis results
sg_predist_sim()
Perform simulations for prediction distribution plots
sg_predist_vis()
Generate prediction distribution visualizations from sg_predist_sim() simulation results
sg_localsens_sim()
Perform local sensitivity analysis simulations
sg_localsens_vis()
Visualize Local Sensitivity Analysis Results
sg_globalsens_sim()
Global sensitivity analysis via PRCC or eFAST
sg_globalsens_vis()
Visualize global sensitivity analysis results
sg_vpop_est()
Perform generation of synthetic datasets for an empirical distribution

Helper functions

Functions to help working with the SimuRg objects

read_smrg_obj()
Read or validate a generalized fit object
read_smrg_ctrl()
Read or validate a generalized control object (GCO)