Main: Main

Description Usage Arguments Value

View source: R/Main.R

Description

Runs VRAP. This function is largely specific to the R version of VRAP.

Usage

1
2
3
4
5
Main(InFile = NULL, OutFileBase = NULL, NRuns = -1, NYears = -1,
  Title = -1, TargetStart = -1, TargetEnd = -1, TargetStep = -1,
  ERecovery = -1, QET = -1, ECrit = -1, NewRavFileName = "tmprav.rav",
  forceNewRav = NULL, silent = FALSE, lcores = 1,
  parallel.backend = "doParallel", save.output.as.files = TRUE)

Arguments

InFile

The name of the .rav file

OutFileBase

The basename for the .sum, .byr, and .esc output files

NRuns

Number of runs to use in the simulations if the user wants to use something different than what is in the .rav file

NYears

Number of years to project forward in the simulations if the user wants to use something different than what is in the .rav file

Title

Title to use for the report if the user wants to use something different than what is in the .rav file

TargetStart

Target ER to start simulations at if the user wants to use something different than what is in the .rav file

TargetEnd

Target ER to end simulations at if the user wants to use something different than what is in the .rav file

TargetStep

Target ER step sizes if the user wants to use something different than what is in the .rav file

ERecovery

Recovery target if the user wants to use something different than what is in the .rav file

QET

if the user wants to use something different than what is in the .rav file

ECrit

if the user wants to use something different than what is in the .rav file

NewRavFileName

A new .rav file is saved in case the user has changed any values from what is in the .rav file.

forceNewRav

Force use of new rav file. Needed for shiny app.

silent

Whether to show progress bar.

lcores

Number of cores to use. Default is non-parallel so lcores=1

parallel.backend

doParallel or doSNOW. The latter allows the progress bar to appear.

save.output.as.files

If TRUE (default), then .sum, .byr, .esc and .rav files are saved using OutFileBase. If FALSE, no files are saved and only the list is output.

Value

list with output list from RunSims() and output time


eeholmes/VRAP documentation built on May 28, 2019, 8:24 a.m.