create_indices_db: Create the indices database

View source: R/create_indices_db.R

create_indices_dbR Documentation

Create the indices database

Description

The internal function checks if indices.json (the database of spectral indices) already exists; if not, it downloads source files and creates it. Since this function depends on xsltproc executable (available only for Linux), this function can be used only from from Linux. It is not necessary, since a indices.json file is present in the package.

Usage

create_indices_db(xslt_path = NA, json_path = NA, force = FALSE)

Arguments

xslt_path

(optional) The path where to install xsltml, an external xsltproc script used to convert MathML index formulas to LaTeX (default: a subdirectory of the package).

json_path

(optional) The path of the output JSON file. Warning: to create a file which will be usable by the package, this option must be left to NA (default location is within the package installation). Edit this only to create the file in another place for external use.

force

(optional) Logical: if FALSE (default), the db is created only if missing or not updated; if TRUE, it is created in any case.

Value

NULL (the function is called for its side effects)

Note

License: GPL 3.0

Author(s)

Luigi Ranghetti, phD (2019)

References

L. Ranghetti, M. Boschetti, F. Nutini, L. Busetto (2020). "sen2r": An R toolbox for automatically downloading and preprocessing Sentinel-2 satellite data. Computers & Geosciences, 139, 104473. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/j.cageo.2020.104473")}, URL: https://sen2r.ranghetti.info/.


sen2r documentation built on Nov. 10, 2023, 9:08 a.m.