get_facts_scenarios {rfacts}R Documentation

List the names of simulation scenarios

Description

Get the names of the simulation scenarios of a FACTS file. without actually running any simulations. These names usually come from the virtual subject response (VSR) scenarios, the accrual profiles, and the dropout profiles.

Usage

get_facts_scenarios(facts_file, verbose = FALSE)

Arguments

facts_file

Character, name of a FACTS file. Usually has a ⁠*.facts⁠ file extension.

verbose

Logical, whether to print progress to the R console.

Value

Character vector of FACTS simulation scenarios.

See Also

get_param_dirs(), run_facts(), run_flfll(), run_engine(), run_engine_contin()

Examples

# Can only run if system dependencies are configured:
if (file.exists(Sys.getenv("RFACTS_PATHS"))) {
facts_file <- get_facts_file_example("contin.facts")
get_facts_scenarios(facts_file)
}

[Package rfacts version 0.2.1 Index]