summary.niOutput: Summarize Index Value Estimates for a Set of NIunits.

View source: R/summary.niOutput.R

summary.niOutputR Documentation

Summarize Index Value Estimates for a Set of NIunits.

Description

Summary method for objects of class niOutput.

Usage

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

Arguments

object

niOutput object.

...

arguments passed on to summary.niSeries controlling the summary:
limits: quantiles to be used as limits in interval 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 list of numeric matrices, one matrix for each NIunit, and each matrix containing interval and point estimates for each year, together with an estimate of the displacement parameter (see summary.niSeries).

Author(s)

Bård Pedersen

See Also

calculateIndex and niOutput for cumputation and generation of 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"))

## End(Not run)


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