readModelData: Read the output files of a project

View source: R/API.R

readModelDataR Documentation

Read the output files of a project

Description

This function reads all or some of the output files of a project, indicated by model and proccess names.

Usage

readModelData(
  projectPath,
  modelName = NULL,
  processName = NULL,
  verifyFiles = FALSE,
  unlist = FALSE,
  emptyStringAsNA = FALSE
)

Arguments

projectPath

The path to the StoX project, i.e., the folder of the project with the sub folders "input", "output" and "process". Can possibly be the path to a file inside the project folder.

modelName

The name of the model (possible values are "baseline", "analysis" and "report").

processName

The name of the process.

verifyFiles

Logical: If TRUE verify that the files are from processes that exist in the project.

unlist

Either 1 to unlist the models, 2 to unlist the models and the process. TRUE is interpreted as 2.

emptyStringAsNA

Logical: If TRUE, read empty strings as NA from the stored original tables, as RstoxFramework has started writing NAs as NAs and not as empty strings.

Value

A list of model output.


StoXProject/RstoxFramework documentation built on Oct. 17, 2023, 1:24 p.m.