Description of the R functions associated to PKanalix scenario

runCAEstimation Estimate the CA parameters for each individual of the project.
runEstimation Run the NCA analysis and the CA analysis if the structural model for the CA calculation is well defined.
runNCAEstimation Estimate the NCA parameters for each individual of the project.
abort Stop the current task run.
getLastRunStatus Return an execution report about the last run with a summary of the error which could have occurred.
isRunning Check if a scenario is currently running.

Estimate the individual parameters using compartmental analysis.

Description

Estimate the CA parameters for each individual of the project.

Usage

runCAEstimation(wait = TRUE)

Arguments

wait
(logical) Should R wait for run completion before giving back the hand to the user. TRUE by default.

Click here to see examples

## Not run:

runCAEstimation()

## End(Not run)


Top of the page, PKanalix-R functions.


Run both non compartmental and compartmental analysis.

Description

Run the non compartmental analysis and the compartmental analysis if the structural model for the CA calculation is defined.

Usage

runEstimation(wait = TRUE)

Arguments

wait
(logical) Should R wait for run completion before giving back the hand to the user. TRUE by default.

Click here to see examples

## Not run:

runEstimation()

## End(Not run)


Top of the page, PKanalix-R functions.


Estimate the individual parameters using non compartmental analysis.

Description

Estimate the NCA parameters for each individual of the project.

Usage

runNCAEstimation(wait = TRUE)

Arguments

wait
(logical) Should R wait for run completion before giving back the hand to the user. TRUE by default.

Click here to see examples

## Not run:

runNCAEstimation()

## End(Not run)


Top of the page, PKanalix-R functions.

Stop the current task run

Description

Stop the current task run.

Usage

abort()

See Also

runScenario

Click here to see examples

## Not run:

abort()

## End(Not run)


Top of the page, PKanalix-R functions.


Get last run status

Description

Return an execution report about the last run with a summary of the error which could have occurred.

Usage

getLastRunStatus()

Value

A structure containing

  1. a boolean which equals TRUE if the last run has successfully completed,
  2. a summary of the errors which could have occurred.

See Also

runScenario abort isRunning

Click here to see examples

## Not run:

lastRunInfo = getLastRunStatus()

lastRunInfo$status

-> TRUE

lastRunInfo$report

-> “”

## End(Not run)


Top of the page, PKanalix-R functions.


Get current scenario state

Description

Check if a scenario is currently running. If yes, information about the current running task are displayed.

Usage

isRunning(verbose = FALSE)

Arguments

verbose
(bool) Should information about the current running task be displayed in the console or not. Equals FALSE by default.

Value

A boolean which equals TRUE if a scenario is currently running.

See Also

runScenario abort

Click here to see examples

## Not run:

isRunning()

## End(Not run)


Top of the page, PKanalix-R functions.