R: Source collection functions

source_collection {sits} | R Documentation

## 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` checks if `access_vars` environment variables are properly defined.

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

`.source_collection_gdal_config()` checks if a collection has a gdalcubes format description.

`.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_gdal_config(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

`source` | A `string` value referring to a valid data source.
`collection` | A `string` value referring to a collection of the source.
`tiles` | A `vector` with the tile names

### 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_gdal_config()` returns the gdal format file path.

`.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.

[Package sits version 0.15.0 Index]