summariseMSI: 'summariseMSI' - Summarise the multispecies indicator for...

View source: R/summariseMSI.R

summariseMSIR Documentation

summariseMSI - Summarise the multispecies indicator for reporting to e.g. JNCC.

Description

This function takes the output of calcMSI and summarises the outputs either as a plot or in the format JNCC require for the UK biodiversity indicators.

Usage

summariseMSI(minYear, maxYear, label, plotType, indicator, method)

Arguments

minYear

Numeric. First year of the indicator.

maxYear

Numeric. Final year of the indicator.

label

String. title for indicator plot.

plotType

String. Type of plot to produce. Options are "indicator" to plot the indicator, or "nSpecies" to plot the number of species contributing to each year of the indicator.

indicator

String. Object returned by calcMSI.

method

String. Method used to calculate the indicator. One of "lambda" or "bma".

Value

If method = "lambda" returns summary stats for reporting to JNCC. Otherwise produces a plot of he indicator.


BiologicalRecordsCentre/wrappeR documentation built on May 3, 2023, 2:36 a.m.