load_box: Load the box specification file for an Atlantis scenario

In r4atlantis/atlantisom: Generates Data Sets From Atlantis Scenarios

Load the box specification file for an Atlantis scenario

Description

Read in the .bgm file that specifies the the box coordinates for an Atlantis scenario.

Usage

load_box(dir = getwd(), file_bgm)

Arguments

dir	The directory of the atlantis model output, where the default is getwd().
file_bgm	A character value specifying the file name of a .bgm file, which contains information on box locations for an Atlantis scenario. The file should be located in your current working directory or the folder you specify in dir. The argument can also be specified as the full path name, just as long as argument dir is specified as NULL.

Value

A list of information regarding boxes for an Atlantis scenario.

Author(s)

Kelli Faye Johnson

See Also

Other load functions: load_agebioind(), load_bioind(), load_biolprm(), load_boxarea(), load_bps(), load_catch(), load_detailed_diet_comp(), load_diet_comp(), load_fgs(), load_fisheries(), load_meta(), load_nc_annage(), load_nc_catchtons(), load_nc(), load_runprm(), load_yoy()

Examples

d <- system.file("extdata", "SETAS_Example", package = "atlantisom")
boxes <- load_box(dir = d, file_bgm = "Geography.bgm")
rm("boxes")

r4atlantis/atlantisom documentation built on Nov. 12, 2023, 2:59 a.m.