make.sh.prm.object: Function that generates a list object used by sh.prm

View source: R/shprm.R

make.sh.prm.objectR Documentation

Function that generates a list object used by sh.prm

Description

Takes data from a box geometry file, a group file, and an Atlantis input parameter file and generates a list object that is the parameter to sh.prm (see Examples).

Usage

make.sh.prm.object(bgm.file, grp.file, prm.file)

Arguments

bgm.file

Box geometry model (.bgm) file used by Atlantis that defines box boundaries and depths.

grp.file

Text file (.csv) used by Atlantis containing group attributes.

prm.file

Text file (.prm) used by Atlantis containing biological parameters.

Value

R list object.

Examples

## Not run: 
bgm.file <- "SEAP_extended_shelf.bgm"
grp.file <- "SEAP_Groups_Aquacult.csv"
prm.file <- "SEAP_biol_pH_Aquacult.prm"
obj <- make.sh.prm.object(bgm.file, grp.file, prm.file)
sh.prm(obj)

## End(Not run)

shanearichards/shinyrAtlantis documentation built on April 10, 2024, 7:19 a.m.