Description of the functions concerning the commons-settings

Description of the functions of the API

getPreferences Get a summary of the project preferences.
getProjectSettings Get a summary of the project settings.
setPreferences Set the value of one or several of the project preferences.
setProjectSettings Set the value of one or several of the settings of the project.

[Monolix – PKanalix – Simulx] Get project preferences

Description

Get a summary of the project preferences. Preferences are:

“relativePath” (bool) Use relative path for save/load operations.
“threads” (int >0) Number of threads.
“timeStamping” (bool) Create an archive containing result files after each run.
“dpi” (bool) Apply high density pixel correction.
“imageFormat” (string) Image format used to save monolix graphics.
“delimiter” (string) Character use as delimiter in exported result files.
“exportCharts” (bool) Should graphics images be exported.
“exportChartsData” (bool) Should graphics data be exported.
“headerAliases” (list(“header” = vector<string>)) For each header, the list of the recognized aliases.

Usage

getPreferences(...)

Arguments


[optional] (string) Name of the preference whose value should be displayed. If no argument is provided, all the preferences are returned.

Value

An array which associates each preference name to its current value.

Click here to see examples

## Not run:

getPreferences() # retrieve a list of all the general settings

getPreferences(“imageFormat”,”exportCharts”)

# retrieve only the imageFormat and exportCharts settings values

## End(Not run)


Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.


[Monolix – PKanalix – Simulx] Get project settings

Description

Get a summary of the project settings.

Associated settings for Monolix projects are:

“directory” (string) Path to the folder where simulation results will be saved. It should be a writable directory.
“exportResults” (bool) Should results be exported.
“seed” (0< int <2147483647) Seed used by random generators.
“grid” (int) Number of points for the continuous simulation grid.
“nbSimulations” (int) Number of simulations.
“dataAndModelNextToProject” (bool) Should data and model files be saved next to project.

Associated settings for Pkanalix projects are:

“directory” (string) Path to the folder where simulation results will be saved. It should be a writable directory.
“dataNextToProject” (bool) Should data files be saved next to project.

Associated settings for Simulx projects are:

“directory” (string) Path to the folder where simulation results will be saved. It should be a writable directory.
“seed” (0< int <2147483647) Seed used by random generators.
“userfilesnexttoproject” (bool) Should user files be saved next to project.

Usage

getProjectSettings(...)

Arguments


[optional] (string) Name of the settings whose value should be displayed. If no argument is provided, all the settings are returned.

Value

An array which associates each setting name to its current value.

See Also

getProjectSettings

Click here to see examples

## Not run:

getProjectSettings() # retrieve a list of all the project settings

getProjectSettings(“directory”,”seed”)

# retrieve only the directopry and the seed settings values

## End(Not run)


Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.


[Monolix – PKanalix – Simulx] Set preferences

Description

Set the value of one or several of the project preferences. Prefenreces are:

“relativePath” (bool) Use relative path for save/load operations.
“threads” (int >0) Number of threads.
“timeStamping” (bool) Create an archive containing result files after each run.
“dpi” (bool) Apply high density pixel correction.
“imageFormat” (string) Image format used to save monolix graphics.
“delimiter” (string) Character use as delimiter in exported result files.
“exportCharts” (bool) Should graphics images be exported.
“exportChartsData” (bool) Should graphics data be exported.
“headerAliases” (list(“header” = vector<string>)) For each header, the list of the recognized aliases.

Usage

setPreferences(...)

Arguments


A collection of comma-separated pairs {preferenceName = settingValue}.

See Also

getPreferences

Click here to see examples

## Not run:

setPreferences(exportCharts = FALSE, delimiter = “,”)

## End(Not run)


Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.


[Monolix – PKanalix – Simulx] Set project settings

Description

Set the value of one or several of the settings of the project.

Associated settings for Monolix projects are:

“directory” (string) Path to the folder where simulation results will be saved. It should be a writable directory.
“exportResults” (bool) Should results be exported.
“seed” (0< int <2147483647) Seed used by random generators.
“grid” (int) Number of points for the continuous simulation grid.
“nbSimulations” (int) Number of simulations.
“dataAndModelNextToProject” (bool) Should data and model files be saved next to project.

Associated settings for Pkanalix projects are:

“directory” (string) Path to the folder where simulation results will be saved. It should be a writable directory.
“dataNextToProject” (bool) Should data files be saved next to project.

Associated settings for Simulx projects are:

“directory” (string) Path to the folder where simulation results will be saved. It should be a writable directory.
“seed” (0< int <2147483647) Seed used by random generators.
“userfilesnexttoproject” (bool) Should user files be saved next to project.

Usage

setProjectSettings(...)

Arguments


A collection of comma-separated pairs {settingName = settingValue}.

See Also

getProjectSettings

Click here to see examples

## Not run:

setProjectSettings(directory = “/path/to/export/directory”, seed = 12345)

## End(Not run)


Top of the page, PKanalix R-functions, Monolix R-functions, Simulx R-functions.

modal close image