sits_configuration {sits}R Documentation

sits configuration

Description

These functions load and show sits configurations.

sits_config() loads the default configuration file and the user provided configuration file. The final configuration is obtained by overriding the options by the values provided in processing_bloat, rstac_pagination_limit, raster_api_package, and gdal_creation_options parameters.

sits_config_show() prints the current sits configuration options. To show specific configuration options for a source, a collection, or a palette, user can inform the corresponding keys to source, collection, and palette parameters.

Usage

sits_config(
  processing_bloat = NULL,
  rstac_pagination_limit = NULL,
  raster_api_package = NULL,
  gdal_creation_options = NULL,
  reset = FALSE
)

sits_config_show(source = NULL, collection = NULL, palette = NULL)

Arguments

processing_bloat

A numeric value to estimate growth size of R memory relative to block size.

rstac_pagination_limit

A numeric value indicating number of items returned by STAC service.

raster_api_package

A character value indicating a supported raster handling package.

gdal_creation_options

A character vector specifying GDAL creation option for GeoTiff image format.

reset

A logical value indicating if current configuration options must be cleaned before load config files. Default FALSE.

source

A character value indicating a source key entry to be shown in detail.

collection

A character value used in conjunction with source parameter to indicate a collection key entry to be shown in detail.

palette

A character value indicating a palette to be shown in detail.

Details

Users can provide additional configuration files, by specifying the location of their file in the environmental variable SITS_CONFIG_USER_FILE.

To see the key entries and contents of the current configuration values, use sits_config_show().

Value

sits_config() returns a list containing the final configuration options.

sits_config_show() returns a list containing the respective configuration printed in the console.

Author(s)

Gilberto Camara, gilberto.camara@inpe.br

Rolf Simoes, rolf.simoes@inpe.br

[Package sits version 0.14.0 Index]