makeAggfileHelpers: Functions to make the area, age, length, predator, and prey...

Description Usage Arguments Value Examples

Description

These are helper functions to the function make_aggfiles. make_<type>_agg_dir functions return a path to the printfile, make_<type>_aggfile produces the content for the aggfile itself, and the check_* family of functions checks for the presence of an aggfile in the printfile_comp of make_aggfiles and returns the aggfile and path if not present.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
make_agg_dir(stocks, aggfile_dir, agg_type)

make_area_agg_dir(stocks, aggfile_dir)

make_age_agg_dir(stocks, aggfile_dir)

make_len_agg_dir(stocks, aggfile_dir)

make_predlen_agg_dir(stocks, aggfile_dir)

make_preylen_agg_dir(stocks, aggfile_dir)

make_area_aggfile(stocks)

make_age_aggfile(stocks)

make_len_aggfile(stocks, len_type = "length")

make_predlen_aggfile(stocks)

make_preylen_aggfile(stocks)

check_agg_type(printfile_comp, agg_type, stocks, aggfile_dir)

isNULL_aggfiles(printfile_comp)

Arguments

stocks

A list of class gadget_stock or gadget_stocks

aggfile_dir

Character. Path of the directory where aggfiles will be printed

printfile_comp

A list of class pertaining to a Gadget printfile component, see update_printfile

Value

make_*_agg_dir returns a character vector of a path to the printfile location. make_*_aggfile returns a character vector of the aggregate file itself ready to be written to file. The check_* functions look to see if the appropriate aggregate file is present, and, if not, will write the aggfile path to the aggfile line in printfile_comp of make_aggfiles and the aggfile as an attribute to printfile_comp.

Examples

1
2
3
4
main <- read_gadget_main(path = gad_mod_dir)
stocks <- read_gagdget_stockfiles(main = main, path = gad_mod_dir)
make_area_agg_dir(stocks, aggfile_dir = "print.aggfiles")
make_area_aggfile(stocks)

inspktrgadget/gadgetSim documentation built on May 10, 2019, 9:51 a.m.