Description of the functions of the API
| addGroup | Add a new simulation group. |
| getGroupRemaining | Get the values of the remaining elements (coming from the observation model) for a group. |
| getGroups | Get the structure of each simulation group. |
| getNbReplicates | Get the number of replicates. |
| getSameIndividualsAmongGroups | Get the informations if the same individuals are simulated among all groups. |
| getSamplingMethod | Define which sampling methods is used for the simulation. |
| getSharedIds | Get the elements for the shared group. |
| removeGroup | Remove a simulation group. |
| removeGroupElement | Remove an element of the simulation. |
| renameGroup | Rename a simulation group. |
| runSimulation | Run the simulation task. |
| setGroupElement | Set the new element of a specific group. |
| setGroupRemaining | Set the values of the remaining elements (coming from the observation model) for a group. |
| setGroupSize | Define the size of a simulation group. |
| setNbReplicates | Define the number of replicates of the simulation. |
| setSameIndividualsAmongGroups | Define if the same individuals will be simulated among all groups. |
| setSamplingMethod | Define which sampling methods will be used for the simulation. |
| setSharedIds | Set the elements for the shared group. |
[Simulx] Add simulation group
Description
Add a new simulation group.
Usage
addGroup(group)
Arguments
group
(string) Name of the group to add.
See Also
Click here to see examples
## Not run:
addGroup(“group”)
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Get simulation group remaining
Description
Get the values of the remaining elements (coming from the observation model) for a group.
Usage
getGroupRemaining(group)
Arguments
group
(character) Group name
See Also
Click here to see examples
## Not run:
getGroupRemaining( group = “arm1” )
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Get simulation groups
Description
Get the structure of each simulation group. Each group is defined as a list of all its elements (population parameters, …) .
Usage
getGroups()
See Also
Click here to see examples
## Not run:
getGroups()
[[1]]
[[1]]$name
[1] “simulationGroup1”
[[1]]$covariate
[1] “mlx_Cov”
[[1]]$parameter
[[1]]$parameter$type
[1] “population”
[[1]]$parameter$name
[1] “mlx_Pop”
[[1]]$treatment
[1] “mlx_Adm1”
[[1]]$output
[1] “mlx_y1”
[[1]]$size
[1] 12
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Get number of replicates
Description
Get the number of replicates.
Usage
getNbReplicates()
See Also
Click here to see examples
## Not run:
getNbReplicates()
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Get same individuals among groups
Description
Get the informations if the same individuals are simulated among all groups.
Usage
getSameIndividualsAmongGroups()
See Also
Click here to see examples
## Not run:
getSameIndividualsAmongGroups()
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Get sampling method
Description
Define which sampling methods is used for the simulation. The possibilities are to keep the order, sample with replacement and sample without replacement.
Usage
getSamplingMethod()
See Also
Click here to see examples
## Not run:
getSamplingMethod()
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Get simulation groups sharedIds
Description
Get the elements for the shared group.
Usage
getSharedIds()
See Also
Click here to see examples
## Not run:
getSharedIds()
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Remove simulation group
Description
Remove a simulation group.
Usage
removeGroup(group)
Arguments
group
(string) Name of the group to remove.
See Also
getGroups,addGroup
Click here to see examples
## Not run:
removeGroup(“group”)
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Remove element from simulation group
Description
Remove an element of the simulation.
Usage
removeGroupElement(group, element)
Arguments
group
(character) Group name
element
(character) Element to remove
Click here to see examples
## Not run:
removeGroupElement(group = “group”, element = “element”)
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Rename simulation group
Description
Rename a simulation group.
Usage
renameGroup(currentGroupName, newGroupName)
Arguments
currentGroupName
(string) Name of the current group name.
newGroupName
(string) Name of the new group name.
See Also
Click here to see examples
## Not run:
renameGroup(“currentGroupName”, “newGroupName”)
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Run simulation
Description
Run the simulation task.
Usage
runSimulation()
See Also
getSimulationResults
[Simulx] Set elements to simulation group
Description
Set the new element of a specific group.
Usage
setGroupElement(group, elements)
Arguments
group
(character) Group name
elements
(character) Vector of new elements that are already defined
See Also
Click here to see examples
## Not run:
setGroupElement(group = “group”, elements = c(“element1”, “element2”))
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Set simulation group remaining
Description
Set the values of the remaining elements (coming from the observation model) for a group.
Usage
setGroupRemaining(group, remaining)
Arguments
group
(character) Group name
remaining
(vector) list of the remaining variables
See Also
Click here to see examples
## Not run:
setGroupRemaining(group=”arm1″, remaining = list(a = 12, b = 3))
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Set simulation group size
Description
Define the size of a simulation group.
Usage
setGroupSize(group, size)
Arguments
group
(string) Name of the group where the size will be changed.
size
(int) Size of the new group.
See Also
Click here to see examples
## Not run:
setGroupSize(“group”, 10)
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Set number of replicates
Description
Define the number of replicates of the simulation.
Usage
setNbReplicates(nb)
Arguments
nb
(int) Number of replicates.
See Also
Click here to see examples
## Not run:
setNbReplicates( nb = 1 )
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Set same individuals among groups
Description
Define if the same individuals will be simulated among all groups.
Usage
setSameIndividualsAmongGroups(value)
Arguments
value
(boolean) Boolean to define if the same individuals will be the same for all groups.
See Also
Click here to see examples
## Not run:
setSameIndividualsAmongGroups( value = TRUE )
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Set sampling method
Description
Define which sampling methods will be used for the simulation. The possibilities are to keep the order, sample with replacement and sample without replacement.
Usage
setSamplingMethod(method)
Arguments
method
(character) keepOrder, withReplacement, withoutReplacement
See Also
Click here to see examples
## Not run:
setSamplingMethod( method = “” )
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
[Simulx] Set simulation groups sharedIds
Description
Set the elements for the shared group.
Usage
setSharedIds(sharedIds)
Arguments
method
(character) The available types are: covariate, output, treatment, regressor, population, individual
See Also
Click here to see examples
## Not run:
setSharedIds( sharedIds = c(“output”, “treatment”) )
## End(Not run)
Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.
