niInput: Create or test for Object of Class 'niInput'

In NINAnor/NIcalc: Functions to Calculate a Nature Index

Create or test for Object of Class niInput

Description

niInput assembles arguments and returns an S3 object of class niInput.
is.niInput tests if a candidate object is of class niInput.

Usage

niInput(
  indicators = NULL,
  ICunits = NULL,
  BSunits = NULL,
  referenceValues = NULL,
  indicatorValues = NULL,
  NIunits = NULL
)

is.niInput(x)

Arguments

indicators	data.frame of indicator data.
ICunits	integer BSunit x indicator matrix of ICunits.
BSunits	data.frame of BSunit data.
referenceValues	data.frame of reference values.
indicatorValues	list of data.frames of indicator values.
NIunits	0/1 BSunit x NIunit matrix of NIunits.
x	object to be tested (is.niInput)

Details

Lists of class niInput contain data sets that are controlled for consistency and for including all necessary data for calculating the Nature Index or a thematic index. niInput objects have the particular structure and format required for data input to the function calculateIndex. The function assembleNiObject returns objects of class niInput.

Value

niInput returns a list of class niInput with elements:

[[1]]	indicators
[[2]]	ICunits
[[3]]	BSunits
[[4]]	referenceValues
[[5]]	indicatorValues
[[6]]	NIunits

is.niInput returns TRUE if the argument is of class niInput

Author(s)

Bård Pedersen

See Also

assembleNiObject, calculateIndex.
The vignette objectsInNIcalc gives a more detailed description of niInput lists.

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