calcMSI: 'calcMSI' - Calculate multispecies indicator.

View source: R/calcMSI.R

calcMSIR Documentation

calcMSI - Calculate multispecies indicator.

Description

This function takes the output of applyFilters and produces a multispecies indicator using the chosen method.

Usage

calcMSI(dat, method, write, outPath, plotLabel, bmaInd = NULL, ...)

Arguments

dat

String. Object returned by applyFilters.

method

String. Which indicator method to use. One of "lambda" or "BMA".

write

Logical. Whether or not to write the outputs to file.

outPath

String. Where to store the outputs if write = TRUE.

plotLabel

String. Title for the indicator plot.

bmaInd

String. Use "prime" if all species data are available for all species in all years, and "reg" otherwise. See Freeman et al. 2020 for details.

...

String. Title for the indicator plot.Additional arguments to be passed to BRCindicators::bma

Value

An list with elements indicator, short term assessment, long term assessment and plot.


robboyd/wrappeR documentation built on Nov. 18, 2022, 10:30 a.m.