Certara.RsNLME (version 3.1.0.1)

RunProfilePertubation: Execute an NLME profile perturbation

Description

Execute an NLME profile perturbation

Usage

RunProfilePertubation(
  hostPlatform,
  dataset,
  params,
  profiles,
  sortColumns,
  scenarios = list(),
  runInBackground = FALSE,
  workingDir = NULL
)

Value

Object of class ProfileNlmeJob

Arguments

hostPlatform

How to execute the run(NlmeParallelHost)

dataset

Dataset and model information(NlmeDataset)

params

Engine parameters(NlmeEngineExtraParams)

profiles

Profiles to perturbate(ProfileParameters)

sortColumns

Optional list of columns to sort and fit(SortColumns)

scenarios

Optional list of scenarios to fit(NlmeScenario)

runInBackground

TRUE will run in background and return prompt(Bool)

workingDir

Directory in which to run the job. Current working directory is used if NULL

Examples

if (FALSE) {
  model <- pkmodel(
    parameterization = "Clearance",
    numCompartments = 2,
    data = pkData,
    ID = "Subject",
    Time = "Act_Time",
    A1 = "Amount",
    CObs = "Conc",
    workingDir = tempdir()
  )

  params <- NlmeEngineExtraParams(
    method = 3,
    numIterations = 1
  )

  host <- hostParams(
    sharedDirectory = tempdir(),
    parallelMethod = "None",
    hostName = "Local",
    numCores = 4
  )

  profile1 <- ProfileVar(
    "tvV",
    9.548,
    "-2,0,2"
  )

  profile2 <- ProfileVar(
    "tvCl",
    0.919,
    "-0.5,0,1.5"
  )

  profiles <- ProfileParameters(
    "USE_DELTA",
    c(profile1, profile2)
  )

  job <- profilePertubate(
    hostPlatform = host,
    params = params,
    profiles = profiles,
    model = model
  )
}