sen2r_getElements: Get information from S2 short name

In sen2r: Find, Download and Process Sentinel-2 Data

Get information from S2 short name

Description

This accessory function extracts metadata included in the name of a Sentinel-2 product which follows the sen2r naming convention (see safe_shortname).

Usage

sen2r_getElements(
  s2_names,
  naming_convention,
  format = "data.table",
  abort = TRUE
)

Arguments

s2_names	A vector of Sentinel-2 product names in the sen2r naming convention.
naming_convention	The naming convention used to extract information from s2_names names. "sen2r" is the sen2r naming convention; an experimental accepted value is "sen2r_new" (it will be documented in future). By default (argument unspecified or NULL), "sen2r" is used unless any s2_names matches "sen2r" while some matches "sen2r_new". Alternatively, a list with the manual definition of the naming convention can be provided (the required format will be documented in a future release).
format	One between data.table (default), data.frame and list.
abort	Logical parameter: if TRUE (default), the function aborts in case any of s2_names is not recognised; if FALSE, a warning is shown, and a list with only the element "type"='unrecognised' is returned.

Value

A data.table, data.frame or list of the output metadata.

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

Examples

# Define product name
fs2nc_examplename <-
  "/path/of/the/product/S2A1C_20170603_022_32TQQ_TOA_20.tif"

# Return metadata
sen2r_getElements(fs2nc_examplename)

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