run_SIMIONtuneR: Runs SIMIONtuneR simulation.

In pasturm/SIMIONtuneR: SIMION Parameter Tuning using Response Surface Methodology

Description

run_SIMIONtuneR runs SIMIONtuneR simulation.

Usage

run_SIMIONtuneR(
  tuneR_config,
  nogui = TRUE,
  write = TRUE,
  zmq = FALSE,
  resume = FALSE,
  digits = 2
)

Arguments

tuneR_config	Path and name of tuneR_config file (.toml).
nogui	Run SIMION with –nogui option (TRUE (default) or FALSE).
write	Write output files (TRUE (default) or FALSE).
zmq	Use the ZeroMQ library for parallel processing (TRUE or FALSE (default)).
resume	If FALSE (default) starting values are taken from the tuneR_config file, if TRUE starting values are taken from the last bestpoint_run.txt (see 'Details').
digits	Controls the number of decimal places to print when printing the best point values.

Details

The experiment needs to be configured in a tuneR_config file (TOML file format). See system.file("SIMIONtuneR_config.toml", package = "SIMIONtuneR") for a template.

If you want to start from a previous best point, set resume = TRUE. If there is a bestpoint_run.txt file in the tuneR directory, the starting values will be taken from there. Otherwise the latest bestpoint_run.txt from all subfolders of tuneR will be taken.

Value

A data.frame containing the best points from the last run.

Examples

## Not run: 
tuneR_config = system.file("SIMIONtuneR_config.toml", package = "SIMIONtuneR")
run_SIMIONtuner(tuneR_config)

## End(Not run)

pasturm/SIMIONtuneR documentation built on Dec. 29, 2020, 2:41 a.m.