summary.niSeries: Summarize a Time Series of Index Value Estimates.

View source: R/summary.niSeries.R

summary.niSeriesR Documentation

Summarize a Time Series of Index Value Estimates.

Description

Summary method for objects of class niSeries.

Usage

## S3 method for class 'niSeries'
summary(object = NULL, ...)

Arguments

object

niSeries object.

...

arguments controlling the summary:
limits: quantiles to be used as limits in intervall estimates ("confidence interval", defaults to c(0.025,0.975)),
locationMean: which location parameter to use as point estimate mean (T) or median (F, default).

Value

a numeric matrix with interval and point estimates for each year, together with an estimate of the displacement in the location parameter due to nonlinear scaling of uncertain indicator observations etc., [cf. Pedersen and Skarpaas (2012)](https://www.nina.no/archive/nina/PppBasePdf/rapport/2012/797.pdf).

Author(s)

Bård Pedersen

See Also

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

Examples

## Not run: 
# Summary of the results from the calculation of a thematic index:

summary(calculateIndex(x = themeData,
                       nsim = 1000,
                       fids = FALSE,
                       tgroups = FALSE,
                       keys = "ignore",
                       w = 0,
                       awbs = TRUE,
                       awBSunit = "Skog")$E)

## End(Not run)


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