modifyProjects: Modify multiple projects

View source: R/Framework.R

modifyProjectsR Documentation

Modify multiple projects

Description

Modify multiple projects

Usage

modifyProjects(
  projectPaths,
  modelNames = getRstoxFrameworkDefinitions("stoxModelNames"),
  newValues,
  add.defaults = FALSE,
  purge.processData = FALSE,
  strict = TRUE,
  update.functionInputs = TRUE
)

Arguments

projectPaths

A vector of paths to the StoX projects.

modelNames

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

newValues

A list named by the elements to modify (see getRstoxFrameworkDefinitions("processProperties") for possible elements), holding the values to modify to (e.g., list(functionParameter = list(DefinitionMethod = "Stratum"))).

add.defaults

Logical: If TRUE defaults of a function are added when setting the function of the process.

purge.processData

Logical: If TRUE replace process data entirely.

strict

Logical: If FALSE a proposed process name is changed to the default new process name, whereas TRUE throws an error.

update.functionInputs

Logical: If TRUE update the process name in the function inputs to other processes.


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