niOutput: Create or test for Objects of Classes niOutput, niSeries,...

In NINAnor/NIcalc: Functions to Calculate a Nature Index

Create or test for Objects of Classes niOutput, niSeries, niValue

Description

niOutput, niSeries, niValue return S3 objects of classes niOutput, niSeries, niValue respectively.
is.niOutput, is.niSeries, is.niValue tests if a candidate object is of each of these classes.

Usage

niOutput(x)

niSeries(x)

niValue(
  indexArea = stop("Required argument 'indexArea' missing with no default", call. = TRUE),
  call = stop("Required argument 'call' missing with no default", call. = TRUE),
  calculationParameters = stop("Required argument 'calculationParameters' missing", call.
    = TRUE),
  metadata = stop("Required argument 'metadata' missing with no default", call. = TRUE),
  year = stop("Required argument 'year' missing with no default", call. = TRUE),
  indicators = stop("Required argument 'indicators' missing with no default", call. =
    TRUE),
  indicatorData = stop("Required argument 'indicatorData' missing with no default", call.
    = TRUE),
  ICunits = stop("Required argument 'ICunits' missing with no default", call. = TRUE),
  ICunitMatrix = stop("Required argument 'ICunitMatrix' missing with no default", call. =
    TRUE),
  imputations = stop("Required argument 'imputations' missing with no default", call. =
    TRUE),
  BSunits = stop("Required argument 'BSunits' missing with no default", call. = TRUE),
  BSunitData = stop("Required argument 'BSunitData' missing with no default", call. =
    TRUE),
  BSunitWeights = stop("Required argument 'BSunitWeights' missing with no default", call.
    = TRUE),
  NIunitWeights = stop("Required argument 'NIunitWeights' missing with no default", call.
    = TRUE),
  BSunitIndices = stop("Required argument 'BSunitIndices' missing with no default", call.
    = TRUE),
  BSunitbbb = stop("Required argument 'BSunitbbb' missing with no default", call. = TRUE),
  indexWeights = stop("Required argument 'indexWeights' missing with no default", call. =
    TRUE),
  index = stop("Required argument 'index' missing with no default", call. = TRUE),
  bbb = stop("Required argument 'bbb' missing with no default", call. = TRUE)
)

is.niOutput(x)

is.niSeries(x)

is.niValue(x)

Arguments

x	a list where each element is of class niSeries (niOutput), a list where each element is of class niValue (niSeries), or object to be tested (is.niOutput, is.niSeries, is.niValue).
indexArea	string, name of NIunit.
call	object of mode "call", unevaluated function call to calculateIndex.
calculationParameters	list of options chosen for the calculation of indices in calculateIndex.
metadata	numeric vector, names(metadata) = c("nIndicators", "nBSunits","nICunits","nImputations") containing metadata describing the input dataset.
year	numeric scalar.
indicators	character vector of indicator names.
indicatorData	data.frame with indicator data.
ICunits	integer vector of ICunit IDs.
ICunitMatrix	BSunit x indicator matrix of ICunit IDs.
imputations	optional data.frame listing indicators and ICunits with imputed values.
BSunits	character vector of BSunit names.
BSunitData	data.frame with BSunit data.
BSunitWeights	numeric BSunits x indicator matrix of BSunit weights.
NIunitWeights	numeric vector of NIunit weights.
BSunitIndices	numeric BSunit x nsim matrix of nsim index values per BSunit.
BSunitbbb	numeric vector of bbb statistics per BSunit.
indexWeights	numeric BSunit x indicators matrix of (NI)weights.
index	numeric vector of length = nsim index values.
bbb	numeric scalar, bbb statistic.

Details

Lists of class niOutput contain the results from the calculation of a set of (time) series of Nature Index or thematic index values for a set of NIunits. The function calculateIndex returns objects of class niOutput. Each element of an niOutput list is itself a list of class niSeries and contains the results from the calculation of a (time) series of index values for a single NIunit. Finally, each element of an niSeries list is a list of class niValue. Objects of class niValue contain the results from the calculation of a single Nature Index or thematic index value.

Value

niOutput returns a list of class niOutput, where each element is of class niSeries.
niSeries returns a list of class niSeries, where each element is of class niValue.
niValue returns S3 object of class niValue
is.niOutput, is.niSeries, and is.niValue returns TRUE if their argument is of class niOutput, niSeries, and niValue respectively.

Author(s)

Bård Pedersen

See Also

The following methods are available within NIcalc: summary.niOutput, summary.niSeries, plot.niSeries, summaryWeights, plot.niValue, and plotWeights
The vignette objectsInNIcalc gives a detailed description of S3 classes defined within NIcalc.

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