run_ed2: Run ED2

In FoRTExperiment/ed4forte: FoRTE-specific utilities for working with ED2

Description

This uses the processx package to create an ED2 process that runs in the background. This allows you to do other things while ED2 is running.

Usage

run_ed2(
  outdir,
  start_dt,
  end_dt,
  configxml = NULL,
  ed2_exe = getOption("ed4forte.ed2_exe"),
  wd = NULL,
  env = NULL,
  stdout = file.path(outdir, "stdout.log"),
  stderr = file.path(outdir, "stderr.log"),
  tz = "UTC",
  ...
)

Arguments

outdir	Output directory
start_dt, end_dt	Start and end date-times of simulation. Can be given as POSIX(ct/lt), or character (in which case, they will be converted via base::as.POSIXct()).
configxml	A list (or data.frame) of parameter values (see write_configxml()) or the path to a configuration XML file.
wd	Process working directory (default, NULL, means current working directory). See processx::process.
env	Process environment variables (default, NULL, means inherit current environment). See processx::process.
tz	time zone specification to be used for the conversion, if one is required. System-specific (see time zones), but "" is the current time zone, and "GMT" is UTC (Universal Time, Coordinated). Invalid values are most commonly treated as UTC, on some platforms with a warning.
...	further arguments to be passed to or from other methods.

Value

A processx::process() object corresponding to the running ED2 process.

Author(s)

Alexey Shiklomanov

FoRTExperiment/ed4forte documentation built on March 21, 2020, 6:54 p.m.