summaryWeights: Weights per Indicator, trophic Group, BSunit or ICunit.

View source: R/summaryWeights.R

summaryWeightsR Documentation

Weights per Indicator, trophic Group, BSunit or ICunit.

Description

Summary method for objects of class niSeries.

Usage

summaryWeights(x = NULL, group = "indic", ...)

Arguments

x

an niSeries object.

group

character. Should summary be per indicator (group = "indic", default), per trophic group (group = "troph"), per BSunit (group = "BSunit"), or per ICunit (group = "ICunit")?

...

argument controlling the summary: indicData logical flag, whether to include additional variables characterizing indicators (i.e. trophic group, fidelity) in the summary per indicator or not, default is F.

Value

a numeric matrix (when group in c("troph","BSunit") or indicData = F) or a dataframe (when group = "ICunit" or indicData = T) with weights per indicator (group = "indic"), per trophic group (group = "troph"), per BSunit (group = "BSunit"), or per ICunit (group = "ICunit"), for each year included in x.

Author(s)

Bård Pedersen

See Also

calculateIndex, niSeries, and niOutput for cumputation and generation of niSeries and niOutput objects.

Examples

## Not run: 
indices <- calculateIndex(x = themeData,
                       nsim = 1000,
                       fids = FALSE,
                       tgroups = FALSE,
                       keys = "ignore",
                       w = 0,
                       awbs = TRUE,
                       awBSunit = "Skog")
summaryWeights(indices$wholeArea, indicData = TRUE)
summaryWeights(indices$E, group = "ICunit")
summaryWeights(indices$E, group = "BSunit")

## End(Not run)


NINAnor/NIcalc documentation built on Oct. 26, 2023, 9:37 a.m.