get_runtime_parameters: Create database of runtime parameters

Description Usage Arguments Details Examples

Description

Create database of runtime parameters

Usage

1
2
get_runtime_parameters(filename, tokens_sep = "=",
  echo_parameters = TRUE)

Arguments

filename

Fully qualified path and filename of text file containing the user-defined runtime parameters.

tokens_sep

Character value used in the parameters file to separate key names and their respective values (defaults to equal sign)

echo_parameters

Boolean flag specifying whether the contents of the runtime parameters file should be printed to the console (default is TRUE)

Details

This function reads a text file containing runtime parameters that will be globally available during the simulation. Each key-value pair must be specified on a single line. The key names are normally nor quoted, and string values generally do not need to be enclosed in quotes unless the string includes whitespace. The key-value pairs are stored in a global list named RTP. It is up to the user to define each of the required run- time parameters, which depend upon the implemented model structure.

Examples

1
RTP <<- get_runtime_parameters("~/Models/test/prelim_params.txt")

rickdonnelly/pcvmodr documentation built on May 14, 2019, 8:17 a.m.