build_structure: Builds the structure of a Hi-sAFe simulation

Description Usage Arguments Value

View source: R/build.R

Description

Does the heavy lifting for build_hisafe.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
build_structure(
  exp.plan,
  path,
  profiles,
  freqs,
  template,
  files,
  plot.scene,
  summary.files,
  stics.diagnostics
)

Arguments

exp.plan

The exp.plan element of a "hip" object, containing a single row.

path

A character string of the path to the simulation folder.

profiles

A character vector of export profiles the simulation should export.

freqs

A numeric vector of exportFrequencies of the export profiles.

template

A character string of the path to the Hi-sAFe directory structure/files to use as a template (or one of the strings signaling a default template)

files

A character string of file types indicating which simulation files to build. Use "all" to write all required simulation files. Otherwise, select one or more of "sim", "pld", "wth", "tree", "plt", "tec", "par", and "pro".

plot.scene

Logical indicating whether plot_hisafe_scene should be used to export plots of each scene during the build.

summary.files

Logical indicating whether or not to write out summary .CSV files about the experiment and each simulation during the build.

stics.diagnostics

Logical indicating whether or not STICS diagnostics files should be exported in the simulation.

Value

Invisibly returns a list containing the original hip object and supplied path.


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