niDataImport: Create or test for Objects of Class niDataImport

In NINAnor/NIcalc: Functions to Calculate a Nature Index

Create or test for Objects of Class niDataImport

Description

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

Usage

niDataImport(
  indicators = NULL,
  referenceValues = NULL,
  indicatorObservations = NULL,
  ICunits = NULL,
  BSunits = NULL,
  ecosystems = NULL
)

is.niDataImport(x)

Arguments

indicators	tibble of indicator data.
referenceValues	list of reference value data.
indicatorObservations	list of observation data.
ICunits	tibble of ICunit data.
BSunits	tibble of BSunit data.
ecosystems	tibble of ecosystem data.
x	object to be tested.

Details

Lists of class niDataImport contain a complete data set for calculating the Nature Index or a thematic index. The function importDatasetApi returns objects of class niDataImport after reading the data from the NI database via the [The Nature Index Application Programming Interface](https://www8.nina.no/NaturindeksNiCalc/index.html).

Value

niDataImport returns a list of class niDataImport with elements:

[[1]]	indicators
[[2]]	referenceValues
[[3]]	indicatorObservations
[[4]]	ICunits
[[5]]	BSunits
[[6]]	ecosystems

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

Author(s)

Bård Pedersen

See Also

Function importDatasetApi. The vignette objectsInNIcalc gives a more detailed description of niDataImport lists.

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