Learn R Programming

sits (version 1.4.0)

sits_configuration: 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, 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, users can inform the corresponding keys to source, collection, and palette parameters.

sits_list_collections() prints the collections available in each cloud service supported by sits. Users can select to get information only for a single service by using the source parameter.

Usage

sits_config(
  run_tests = NULL,
  run_examples = NULL,
  processing_bloat = NULL,
  rstac_pagination_limit = NULL,
  raster_api_package = NULL,
  gdal_creation_options = NULL,
  gdalcubes_chunk_size = NULL,
  leaflet_max_megabytes = NULL,
  leaflet_comp_factor = NULL,
  reset = FALSE
)

sits_config_show(source = NULL, collection = NULL, colors = FALSE)

sits_list_collections(source = NULL)

Value

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

A list containing the respective configuration printed in the console.

Prints collections available in each cloud service supported by sits.

Arguments

run_tests

Should tests be run?

run_examples

Should examples be run?

processing_bloat

Estimated growth size of R memory relative to block size.

rstac_pagination_limit

Limit of number of items returned by STAC.

raster_api_package

Supported raster handling package.

gdal_creation_options

GDAL creation options for GeoTiff.

gdalcubes_chunk_size

Chunk size to be used by gdalcubes

leaflet_max_megabytes

Max image size of an image for leaflet (in MB)

leaflet_comp_factor

Compression factor for leaflet RGB display.

reset

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

source

Data source to be shown in detail.

collection

Collection key entry to be shown in detail.

colors

Show colors?

Author

Gilberto Camara, gilberto.camara@inpe.br

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

Run the code above in your browser using DataLab