Certara.RDarwin (version 1.1.1)

run_pyDarwin: Run pyDarwin Model Search

Description

This function runs a pyDarwin model search using the specified parameters. It launches the search process and monitors its progress.

Usage

run_pyDarwin(
  InterpreterPath,
  Flags = c("-u", "-m"),
  DirectoryPath = ".",
  TemplatePath = "template.txt",
  TokensPath = "tokens.json",
  OptionsPath = "options.json",
  Wait = TRUE
)

Value

If Wait is TRUE, a list containing the results of the search, including a data frame for all models executed, a final model and properties of the final model generated by pyDarwin when available. If nothing is available, messages.txt file text is given. If Wait is FALSE, messages.txt file location is returned where raw output of pyDarwin run is stored.

Arguments

InterpreterPath

Path to the Python interpreter executable.

Flags

Flags to pass to the Python interpreter. Refer to Python documentation for details. Note that -m is essential (runs library module as a script and terminates option list).

DirectoryPath

Optional path to the directory containing template file, tokens file and options file. If that argument is given, it overrides the paths of TemplatePath, TokensPath, OptionsPath with warning. Default is current working directory.

TemplatePath

Path to the template file.

TokensPath

Path to the tokens JSON file.

OptionsPath

Path to the options JSON file.

Wait

Logical. If TRUE, the function waits for the search process to complete and returns the results. If FALSE, the process is launched and exits immediately.

Examples

if (FALSE) {
result <- run_pyDarwin(
  InterpreterPath = "~/darwin/venv/bin/python",
  DirectoryPath = "~/project_folder",
  TemplatePath = "template.txt",
  TokensPath = "tokens.json",
  OptionsPath = "options.json"
)
}