Create an Emax or Imax model

Use to create an Emax or Imax model

Usage

emaxmodel(
  isPopulation = TRUE,
  checkBaseline = FALSE,
  checkFractional = FALSE,
  checkInhibitory = FALSE,
  checkSigmoid = FALSE,
  data = NULL,
  columnMap = TRUE,
  modelName = "",
  workingDir = "",
  ...
)

Arguments

isPopulation

Is this a population model TRUE or individual model FALSE?

checkBaseline

Set to TRUE if the model contains a baseline response.

checkFractional

Set to TRUE to modify the default form for the model. Only applicable to models with checkBaseline = TRUE.

checkInhibitory

Set to TRUE to change the model from an Emax to an Imax model.

checkSigmoid

Set to TRUE to change the model to its corresponding signmoid form.

data

Input dataset

columnMap

If TRUE (default) column mapping arguments are required. Set to FALSE to manually map columns after defining model using colMapping.

modelName

Model name for subdirectory created for model output in current working directory.

workingDir

Working directory to run the model. Current working directory will be used if workingDir not specified.

...

Arguments passed on to emaxmodel_MappingParameters

ID

Column mapping argument for input dataset column(s) that identify individual data profiles. Only applicable to population models isPopulation = TRUE.

C

Column mapping argument that represents the input dataset column for the independent variable that is treated as a covariate during the estimation/simulation process.

EObs

Column mapping argument that represents the input dataset column for the observed drug effect (i.e., the dependent variable).

Value

NlmePmlModel object

Column mapping

Note that quoted and unquoted column names are supported. Please see colMapping.

Examples

model <- emaxmodel(data = pkpdData, ID = "ID", C = "CObs", EObs = "EObs")

model <- emaxmodel(
  checkBaseline = TRUE,
  checkFractional = TRUE,
  checkInhibitory = TRUE,
  data = pkpdData,
  ID = "ID",
  C = "CObs",
  EObs = "EObs"
)

# View PML Code
print(model)
#> 
#>  Model Overview 
#>  ------------------------------------------- 
#> Model Name        :  Model_25_08_06_07_12
#> Working Directory :  C:/Repos/R-RsNLME/docs/reference/Model_25_08_06_07_12
#> Is population     :  TRUE
#> Model Type        :  EMAX
#> 
#>  PD 
#>  ------------------------------------------- 
#> Check Baseline    :  TRUE
#> Check Inhibitory  :  TRUE
#> Check Sigmoid     :  FALSE
#> Check Fractional  :  TRUE
#> Effect Compartment:  FALSE
#> Freeze PD         :  FALSE
#> 
#>  PML 
#>  ------------------------------------------- 
#> test(){
#>     covariate(C)
#>     E = E0 * (1 - Imax * C / (IC50 + C))
#>     error(EEps=1)
#>     observe(EObs(C)=E + EEps)
#>     stparm(IC50 = tvIC50 * exp(nIC50))
#>     stparm(E0 = tvE0 * exp(nE0))
#>     stparm(Imax = tvImax * exp(nImax))
#>     fixef( tvIC50 = c(,1,))
#>     fixef( tvE0 = c(,1,))
#>     fixef( tvImax = c(,1,))
#>     ranef(diag(nIC50,nE0,nImax) =  c(1,1,1))
#> }
#> 
#>  Structural Parameters 
#>  ------------------------------------------- 
#>  IC50 E0 Imax
#>  ------------------------------------------- 
#> Observations:
#> Observation Name :  EObs
#> Effect Name      :  E
#> Epsilon Name     :  EEps
#> Epsilon Type     :  Additive
#> Epsilon frozen   :  FALSE
#> is BQL           :  FALSE
#>  ------------------------------------------- 
#>  Column Mappings 
#>  ------------------------------------------- 
#> Model Variable Name : Data Column name
#> id                  : ID
#> C                   : CObs
#> EObs                : EObs
#>