Source collection functions

Description

These functions provide an API to handle/retrieve data from source's collections.

.source_collections() lists all collections of a source.

.source_collection_access_vars_set sets access_vars environment variables.

.source_collection_check() checks if a collection is from a source.

.source_collection_gdalcubes_type() checks if a collection has a gdalcubes type for writing files.

.source_collection_gdalcubes_support() checks if a collection can be regularized using gdalcubes.

.source_collection_gdalcubes_config() checks if a collection has a gdalcubes format description.

.source_collection_metadata_search() retrieves the metadadata search strategy for a given source and collection.

.source_collection_name() returns the name of a collection in its original source.

.source_collection_open_data() informs if a collection is open data or not.

.source_collection_open_data_token() informs if a collection requires a token to access.

.source_collection_token_check() checks if a collection needs environmental variables.

.source_collection_tile_check() checks if a collection requires tiles to be defined

Usage

.source_collections(source, ...)

.source_collection_access_test(source, collection, ...)

.source_collection_access_vars_set(source, collection)

.source_collection_check(source, collection)

.source_collection_gdalcubes_type(source, collection)

.source_collection_gdalcubes_support(source, collection)

.source_collection_gdalcubes_config(source, collection)

.source_collection_metadata_search(source, collection)

.source_collection_name(source, collection)

.source_collection_open_data(source, collection)

.source_collection_open_data_token(source, collection)

.source_collection_token_check(source, collection)

.source_collection_tile_check(source, collection, tiles)

Arguments

Value

The values returned by each function are described as follows.

.source_collections() returns a character vector with all collection names of a given source.

.source_collection_access_vars_set returns NULL if no error occurs.

.source_collection_check() returns NULL if no error occurs.

.source_collection_gdalcubes_type() returns the gdal type.

true/false

.source_collection_gdal_config() returns the gdal format file path.

.source_collection_metadata_search() returns a character value with the metadata search strategy.

.source_collection_name() returns a character.

.source_collection_open_data() returns a logical.

.source_collection_open_data_token() returns a logical.

.source_collection_token_check() returns NULL if no error occurs.

.source_collection_tile_check() returns NULL if no error occurs.