Learn R Programming

sits (version 1.4.1)

sits_config: Configure parameters for sits package

Description

These functions load and show sits configurations.

The `sits` package uses a configuration file that contains information on parameters required by different functions. This includes information about the image collections handled by `sits`.

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, gdal_creation_options and gdalcubes_chunk_size

Usage

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

Value

A list containing the current configuration options.

Arguments

processing_bloat

Estimated growth size of R memory relative to block size.

rstac_pagination_limit

Limit of number of items returned by STAC.

gdal_creation_options

GDAL creation options for GeoTiff.

gdalcubes_chunk_size

Chunk size to be used by gdalcubes

reset

Should current configuration options be cleaned before loading config files? Default is FALSE.

Author

Rolf Simoes, rolf.simoes@inpe.br

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().

Examples

Run this code
current_config <- sits_config()

Run the code above in your browser using DataLab