R/data.R

In e-sensing/in-situ: inSitu e-sensing data sets

#' @title List data sets
#' @name list_datasets
#' @author Rolf Simoes, \email{rolf.simoes@@inpe.br}
#'
#' @description Lists all data sets provided by the package.
#'
#' @return character vector with all data sets names.
#'
#' @examples
#' list_datasets()
#'
#' @export
list_datasets <- function() {
  return(c("amazonia_33K_12classes_4bands",
           "cerrado_61K_14classes_4bands",
           "br_mt_1_8K_9classes_6bands",
           "cbers_samples_022024",
           "samples_S2_T20LKP_2018_2019"))
}

#' @title Samples of Amazonia biome
#' @name amazonia_33K_12classes_4bands
#' @docType data
#'
#' @description A dataset containing a sits tibble with time series samples from Brazilian Amazonia biome.
#'
#' @format A \code{sits} tibble with 33K samples. A \code{sits} tibble contains the following meta-data:
#'   longitude (East-west coordinate of the time series sample in WGS 84),
#'   latitude (North-south coordinate of the time series sample in WGS 84),
#'   start_date (initial date of the time series),
#'   end_date (final date of the time series),
#'   label (the class label associated to the sample),
#'   coverage (the name of the coverage associated with the data), and
#'   time_series ( list containing a tibble with the values of the time series).
#'
#'   The samples are from the work of Ana Rorato, combined with agricultural data provided by EMBRAPA.
#'   There are samples of 12 classes ("Fallow_Cotton", "Forest", "Millet_Cotton", "Pasture", "Savanna",
#'   "Savanna_Roraima", "Soy_Corn", "Soy_Cotton", "Soy_Fallow", "Soy_Millet", "Soy_Sunflower" and "Wetlands").
#'
#'   Each time series covers 12 months (23 data points) from the MOD13Q1 product,
#'   in 4 bands ("ndvi", "evi", "nir", "mir").
#'
#' @usage
#' data("amazonia_33K_12classes_4bands")
#'
NULL

#' @title Samples of Cerrado biome
#' @name cerrado_61K_14classes_4bands
#' @docType data
#'
#' @description A dataset containing a sits tibble with time series samples from Brazilian Cerrado biome.
#'
#' @format A \code{sits} tibble with 61K samples. A \code{sits} tibble contains the following meta-data:
#'   longitude (East-west coordinate of the time series sample in WGS 84),
#'   latitude (North-south coordinate of the time series sample in WGS 84),
#'   start_date (initial date of the time series),
#'   end_date (final date of the time series),
#'   label (the class label associated to the sample),
#'   coverage (the name of the coverage associated with the data), and
#'   time_series ( list containing a tibble with the values of the time series).
#'
#'   The samples are from many sources. It has 13 classes ("Araguaia", "Campo_Cerrado",
#'   "Cerradao", "Cerrado", "Cerrado_Rupestre", "Dunas",
#'   "Fallow_Cotton", "Millet_Cotton", "Pasture", "Silvicultura",
#'   "Soy_Corn", "Soy_Cotton", "Soy_Fallow", "Soy_Millet").
#'
#'   Each time series comprehends 12 months (23 data points) from MOD13Q1 product, and has 4 bands
#'   ("evi", "ndvi", "mir", and "nir").
#'
#' @usage
#' data("cerrado_61K_14classes_4bands")
#'
NULL

#' @title Samples of Cerrado biome
#' @name br_mt_1_8K_9classes_6bands
#' @docType data
#'
#' @description A dataset containing a sits tibble with time series samples from Brazilian
#' Mato Grosso State (Amazon and Cerrado biomes).
#'
#' @format A \code{sits} tibble with 1.8K samples and 9 classes ("Cerrado",
#'   "Fallow_Cotton", "Forest", "Millet_Cotton", "Pasture",
#'   "Soy_Corn", "Soy_Cotton", "Soy_Fallow", "Soy_Millet").
#'    Each time series comprehends 12 months (23 data points)
#'    from MOD13Q1 product, with 6 bands.
#'
#' @usage
#' data("br_mt_1_8K_9classes_6bands")
#'
NULL

#' @title Samples for an area of the Brazilian Cerrado using CBERS-4 AWFI image
#' @name cbers_samples_022024
#' @docType data
#' @keywords datasets
#' @description A dataset containing a tibble with time series sampled on the
#' Brazilian Cerrado. The time series come from a set of CBERS-4 AWFI images
#' over tile "022024" of the Brazilian Data Cube.
#' The CBERS-4 AWFI is a sensor with 64 meter resolution.
#'
#' @format A tibble with 1 rows and 7 variables: longitude, latitude, start_date
#'   (initial date of the time series), end_date (final date of the time series),
#'   label (the class label associated to the sample),
#'   cube (the name of the data cube associated with the time series),
#'   time_series (list containing a tibble with the values of the time series).
#'   Each time series comprehends one year of 16-day composites
#'   from AWFI images, comprising 23 data points and 6 bands
#'   (blue, green, red, nir, ndvi, evi)
#'
#' @usage
#' data(cbers_samples_022024)
#'
NULL

#' @title Samples for an area in Amazonia using SENTINEL-2/2A MSI data
#' @name samples_S2_T20LKP_2018_2019
#' @docType data
#' @keywords datasets
#' @description A dataset containing a tibble with time series sampled on the
#' Brazilian Amazonia (Rondonia state). The time series come from a set of SENTINEL-2/2A MSI images
#' over tile "T20LKP" of the standard S2 grid.
#'
#' @format A tibble with 1 rows and 7 variables: longitude, latitude, start_date
#'   (initial date of the time series), end_date (final date of the time series),
#'   label (the class label associated to the sample),
#'   cube (the name of the data cube associated with the time series),
#'   time_series (list containing a tibble with the values of the time series).
#'   Each time series comprehends one year of composites of S2 and S2A images,
#'   comprising 36 data points and 11 bands and indices
#'   (B02, B03, B07, B08, B8A, B11, B12, evi, ndvi, ndmi, savi)
#'
#' @usage
#' data(samples_S2_T20LKP_2018_2019)
#'
NULL