preGUI: Prepare files needed by the GUI
In dkneis/rodeoGUI: Generic GUI for rodeo-based models

View source: R/runGUI.R

preGUI

R Documentation

Prepare files needed by the GUI

Description

Prepare files needed to run a rodeo-based model in the shiny GUI.

Usage

preGUI(
  appName = "rodeoGUI",
  vars = "vars.txt",
  pars = "pars.txt",
  funs = "funs.txt",
  pros = "pros.txt",
  stoi = "stoi.txt",
  sourcesR = "functions.r",
  sourcesF = "functions.f95",
  dirScenarios = "./scenarios",
  dirIntro = "./intro",
  colsep = "\t",
  useTemp = TRUE,
  maxNumberOfScenarios = 3,
  maxNumberOfTimeSteps = 10000,
  tStart = 0,
  tFinal = 10,
  tStep = 0.1,
  tShow = 0,
  header = NULL,
  footer = NULL
)

Arguments

`appName`	Application name displayed in top left corner of GUI.
`vars`	Input table.
`pars`	Input table.
`funs`	Input table.
`pros`	Input table.
`stoi`	Input table.
`sourcesR`	R source files.
`sourcesF`	Fortran source files.
`dirScenarios`	Directory containing scenario definitions. See notes.
`dirIntro`	Directory containing material for the model's introduction pages. See notes.
`colsep`	Column separator used in delimited text files.
`useTemp`	If `TRUE` (default), the produced files are created in the session's temporary folder. If `FALSE`, the files are creared in the current working directory (which is rarely useful if the GUI is to be run on the local machine).
`maxNumberOfScenarios`	Maximum number of scenarios that can be active at a time. Reasonable values are between 2 and 4.
`maxNumberOfTimeSteps`	Maximum allowed number of time steps in dynamic simulations. The chosen value should take into account the resources of the machine as well as the number of parallel sessions in a multi-user environment.
`tStart`	Start of dynamic simulation period. Default value.
`tFinal`	End of dynamic simulation period. Default value.
`tStep`	Time step for dynamic simulation. Default value.
`tShow`	Time after which dynamic results are displayed. Default value.
`header`	HTML code used as page header.
`footer`	HTML code used as page footer.

Value

The function does not return anything but it creates two files in the current working directory. The first file with the fixed name 'rodeoGuiData.rda' holds various data needed by the GUI. The second file is a system-specific shared library. The file name starts with 'rodeo' followed by a random pattern and the extension according to the dynlib.ext component of .Platform.