gipp_init: Copy L2A_GIPP.xml in sen2r

View source: R/gipp.R

gipp_initR Documentation

Copy L2A_GIPP.xml in sen2r

Description

Internal function to copy L2A_GIPP.xml from default Sen2Cor directory to sen2r. After that, user will allow editing Sen2Cor options in sen2r without affecting standalone Sen2Cor behaviour.

Usage

gipp_init(gipp_sen2r_path = NA, force = FALSE, dem_warning = FALSE)

Arguments

gipp_sen2r_path

Character path of the output GIPP XML file. By default it is equal to NA (meaning the default sen2r GIPP path).

force

Logical: if TRUE, the file is copied in any case; if FALSE (default), only if it does not yet exist.

dem_warning

TEMPORARY ARGUMENT Logical: if TRUE, a warning about the fact that DEM_Directory XML parameter was not overwritten is shown (default is FALSE). This argument will be removed when use_dem = TRUE will become the default.

Value

TRUE if the file was copied, FALSE elsewhere (invisible output)

Note

License: GPL 3.0

Author(s)

Luigi Ranghetti, phD (2020)

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/.

Examples

## Not run: 
gipp_init()

## End(Not run)

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