list_indices: List spectral indices

Description Usage Arguments Value Note Author(s)

View source: R/fct_list_indices.R

Description

Return a table with attributes of the spectral indices computable with the package.

Usage

1
list_indices(values, pattern = "", all = FALSE)

Arguments

values

A vector of attributes which will be returned, being one or more within the followings: - 'n_index': internal index identifiers; - 'name': index name; - 'longname': index description; - 'link': URL to the index description page; - 's2_formula': expression containing the formula to compute the index; - 's2_formula_mathml': MathML version of the formula; - 'checked': logical (TRUE for verified indices); - 'a', 'b', 'x': parameter values (NA for non required parameters).

pattern

A regular expression on index names.

all

Logical: if TRUE, all the indices retrieved from [IDB](http://www.indexdatabase.de/db/is.php?sensor_id=96) are returned; if FALSE (default), only indices checked by the authors are returned.

Value

A data.frame with the required information. The table contains also the following attributes: - 'creation_date': timestamp of the creation date of the indices archive; - 'pkg_version': version of the 'sen2r' package used to create the indices archive.

Note

License: GPL 3.0

Author(s)

Luigi Ranghetti, phD (2019) luigi@ranghetti.info


pobsteta/shinyCNES documentation built on April 28, 2021, 9:43 a.m.