runProject_ReplaceAcousticFiles: Add a process DefineAcousticPSU with DefinitionMethod...

In StoXProject/RstoxFramework: The Engine of StoX

Add a process DefineAcousticPSU with DefinitionMethod "PreDefined"

Description

This function adds a process named DefineAcousticPSU using the function DefineAcousticPSU with DefinitionMethod = "PreDefined". It is a requirement that there exists a procecss named DefineAcousticPSU in the project, which will be renamed and used as input to the new DefineAcousticPSU process.

Usage

runProject_ReplaceAcousticFiles(
  projectPath,
  ReadAcoustic.FileNames,
  modelNames = getRstoxFrameworkDefinitions("stoxModelNames"),
  projectPath0 = NULL,
  run = TRUE,
  AcousticPSUProcessName = "DefineAcousticPSU",
  AcousticPSUProcessNameNew = "DefineAcousticPSU0",
  save = NULL,
  ow = 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.
ReadAcoustic.FileNames	Optional: character vector with file paths to input acoustic files to replaec the existing acoustic files by in the procecss using the function ReadAcoustic.
modelNames	The name of the models (possible values are "baseline", "analysis" and "report").
projectPath0	Optional: Path to the project to copy to the project given by projectPath.
run	Logical: If TRUE run the model.
AcousticPSUProcessName	The name of the existing process using DefineAcousticPSU.
AcousticPSUProcessNameNew	The new name of the existing process using DefineAcousticPSU.
save	Logical: If TRUE save the project after running.
ow	Logical: If TRUE overwrite the project.

Value

A list of model output.

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