scarabee.clean: Cleaning of the Run Directory

Description Usage Arguments Author(s) See Also

View source: R/scarabee.clean.R

Description

scarabee.clean is a secondary function called at each scaRabee run. It cleans the run directory from unwanted files. scarabee.clean is typically not called directly by users.

Usage

1
2
  scarabee.clean(files = NULL,
                 analysis = NULL)

Arguments

files

A list of input used for the analysis. The following elements are expected and none of them could be null:

data

A .csv file located in the working directory, which contains the dosing information, the observations of the dependent variable(s) to be modeled, and possibly covariate information. The expected format of this file is described in details in vignette('scaRabee', package='scaRabee').

param

A .csv file located in the working directory, which contains the initial guess(es) for the model parameter(s) to be optimized or used for model simulation. The expected format of this file is described in details in vignette('scaRabee',package='scaRabee').

model

A text file located in the working directory, which defines the model. Models specified with explicit, ordinary or delay differential equations are expected to respect a certain syntax and organization detailed in vignette('scaRabee',package='scaRabee').

iter

A .csv file reporting the values of the objective function and estimates of model parameters at each iteration.

report

A text file reporting for each individual in the dataset the final parameter estimates for structural model parameters, residual variability and secondary parameters as well as the related statistics (coefficients of variation, confidence intervals, covariance and correlation matrix).

pred

A .csv file reporting the predictions and calculated residuals for each individual in the dataset.

est

A .csv file reporting the final parameter estimates for each individual in the dataset.

sim

A .csv file reporting the simulated model predictions for each individual in the dataset. (Not used for estimation runs).

analysis

A character string directly following the $ANALYSIS tag in the model file.

Author(s)

Sebastien Bihorel (sb.pmlab@gmail.com)

See Also

scarabee.analysis


sbihorel/scaRabee documentation built on Feb. 7, 2022, 9:50 p.m.