read_simulation: Read output from a single Hi-sAFe simulation

Description Usage Arguments Value

View source: R/read.R

Description

Reads the designated output profiles from a single Hi-sAFe simulation. Called from within read_hisafe.

Usage

1
2
3
4
5
6
7
8
9
read_simulation(
  simu.name,
  hip,
  path,
  profiles,
  show.progress,
  read.inputs,
  max.size
)

Arguments

simu.name

The SimulationName of the Hi-sAFe simulation to read. This must be the same as the name of the Hi-sAFe simulation folder. Cannot provided both hip and simu.name.

hip

An object of class "hip". To create a hip object see define_hisafe. Cannot provided both hip and simu.name. If hip is not provided, then path is required and the input data for the experiment is read from the experiment summary .csv file created when building the experiment.

path

A character string of the path to the directory containing the Hi-sAFe simulation folder. If hip is not provided, then path is required. If both hip and path are provided, path is used.

profiles

A character vector of the names of Hi-sAFe output profiles to read. If "all" the default, reads all supported Hi-sAFe output profiles. For currently supported profiles see: hisafe_profiles

show.progress

Logical indicating whether progress messsages should be printed to the console.

read.inputs

Logical indicating whether data should be read from the .PLD and .SIM files for the tree.info and plot.info data slots. Setting this to FALSE severly limits hisafer's plotting/analysis capacity. Should only be set to FALSE if input files are corrupted.

max.size

The maximum file size (MB) that should be read. Files larger than this value will be ignored, with a warning.

Value

An object of class "hop". This is a list of 12 data frames (tibbles):


kevinwolz/hisafer documentation built on Oct. 19, 2020, 4:43 p.m.