ffm_run_command: Composes a command line call to run a simulation

In pzylstra/frame_r: Fire Research and Modelling Environment

Composes a command line call to run a simulation

Description

This function is used by ffm_run when calling the Scala model application via the base R system function. The command line string passed to system invokes the local Java runtime and includes arguments for the necessary Java libraries (jar files included with the package), the CSV-format file of input parameters, the path to the output database, and (optionally) a flag indicating that the database should be recreated if the file exists.

Usage

ffm_run_command(
  param.path,
  db.path,
  db.recreate = FALSE,
  runtime.class = "ffm.runner.CSVRunner"
)

Arguments

param.path	Path and name of a CSV-format file of simulation parameters.
db.path	Path and name of the output SQLite database file.
db.recreate	A logical value indicating, if the file specified by db.path exists, whether to recreating the database (TRUE) or append to it (FALSE). Default is to append.
runtime.class	The name of the runtime class in the Scala model application. Unless you have modified the Scala application this should be left as the default value: ffm.runner.CSVRunner.

Value

The command line instruction as a one-element character vector.

pzylstra/frame_r documentation built on Nov. 12, 2023, 1:55 a.m.