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

Description Usage Arguments Value Examples

View source: R/shdist.R

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

1

Arguments

bgm.file

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

Value

R list object.

Examples

1
2
3
4
5
6
## 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 May 26, 2017, 7:02 a.m.