make.sh.dist.object: Function that generates an object used by sh.dist

View source: R/shdist.R

make.sh.dist.objectR Documentation

Function that generates an object used by sh.dist

Description

Takes data from a box geometry model file used by Atlantis to define box boundaries and uses it to generates a list object that is the parameter to sh.dist.

Usage

make.sh.dist.object(bgm.file)

Arguments

bgm.file

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

Value

R list object.

Examples

## Not run: 
bgm.file <- "gbr_box_03012012.bgm"
dist.object <- make.sh.dist.object(bgm.file)
sh.dist(dist.object)

## End(Not run)

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