# Pharmacometric Modeling

## Documentation for package ‘Certara.RsNLME’ version 3.1.1

- DESCRIPTION file.

## Help Pages

addADDL | Adds ADDL extra column definition to model object
addCovariate | Add covariate to model object
addDoseCycle | Adds a dosing cycle to model
addExtraDef | Adds user defined extra column/table definitions to column definition file
addInfusion | Change existing dosing compartment to infusion
addLabel | Add levels and labels to categorical or occasion covariate
addMDV | Adds MDV extra column definition to model object
addReset | Adds reset instructions to the model
addReset-method | Adds reset instructions to the model
addSecondary | Adds a secondary parameter to model definition
addSecondary-method | Adds a secondary parameter to model definition
addSteadyState | Adds Steady State extra column definition to model object
bootstrap | Executes an NLME Bootstrap
cancelJob | Generic function for cancelling a job
cancelJob-method | Generic function for cancelling a job
colMapping | Add column mappings
copyModel | Copy model object to iterate over base model
covariateNames | Return covariate names
createModelInfo | Parse the model and get the list of terms
dataMapping | Initialize input data for PK/PD model
doseNames | Return dose names
editModel | Directly edit PML text in model object
emaxmodel | Create an Emax or Imax model
engineParams | Main function to specify engine parameters
extraDoseLines | Return extra dose lines
extraDoseNames | Return extra dose names
fitmodel | Executes an NLME simple estimation
fixedEffect | Specifies the initial values, lower bounds, upper bounds, and units for fixed effects in a model
getRandomEffectNames | Return random effect names in model
getThetas | Return theta names and values
hostParams | Create an NLME Parallel Host Configuration
initFixedEffects | Display/Set initial estimates for fixed effects
initFixedEffects-method | Display/Set initial estimates for fixed effects
initFixedEffects<- | Display/Set initial estimates for fixed effects
initFixedEffects<--method | Display/Set initial estimates for fixed effects
linearmodel | Create linear model
listCovariateEffectNames | Lists covariate effect names in the model
listCovariateEffectNames-method | Lists covariate effect names in the model
modelVariableNames | Return model variable names
obtain_NLMELicense | Obtain NLME License
OneCpt_IVInfusionData | Pharmacokinetic dataset containing 100 subjects with single dose given by infusion
parsePMLColMap | Embed column definition info into the model
pkcovbqlData | Pharmacokinetic pediatric dataset containing 80 subjects with single bolus dose.
pkData | Pharmacokinetic dataset containing 16 subjects with single bolus dose
pkemaxmodel | Create a PK/Emax or PK/Imax model
pkindirectmodel | Create a PK/Indirect response model
pklinearmodel | Create PK linear model
pkmodel | Creates a PK model
pkpdData | Pharmacokinetic/Pharmacodynamic dataset containing 200 subjects with single bolus dose
print.NlmePmlModel | Print generic for class NlmePmlModel
randomEffect | Sets or updates the covariance matrix of random effects
removeCovariate | Remove covariate from structural parameters in a model object.
remove_NLMELicense | Remove NLME License
residualEffectNames | Return residual effect terms available in model
residualError | Assign residual error model to model object
secondaryParameterNames | Get secondary parameter names
shotgunSearch | Executes an NLME shotgun covariate search
simmodel | Executes an NLME simulation
sortfit | Executes an NLME simple estimation with sort keys and given scenarios
stepwiseSearch | Executes an NLME stepwise covariate search
structuralParameter | Set structural parameter in model object
structuralParameterNames | Get structural parameter names
tableParams | Wrapper around NlmeTableDef/NlmeSimTableDef-classes initializers.
textualmodel | Create a textual model object
vpcmodel | Perform visual predictive check for NLME models