load_boxarea: Extract the box area from the bgm-file

In r4atlantis/atlantisom: Generates Data Sets From Atlantis Scenarios

Extract the box area from the bgm-file

Description

This function extracts the box area for each polygon from the atlantis bgm-file.

Usage

load_boxarea(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

dataframe with the columns polygon and area. Polygon gives the box id as integer and area is the box size in m^2.

See Also

Other load functions: load_agebioind(), load_bioind(), load_biolprm(), load_box(), 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")
boxarea <- load_boxarea(dir = d, file_bgm = "Geography.bgm")
rm("boxarea")

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