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_aws()` returns the `aws` attribute of a collection. The attribute must define the following AWS environment variables: `AWS_DEFAULT_REGION`, `AWS_S3_ENDPOINT`, and `AWS_REQUEST_PAYER`.

`.source_collection_aws_check()` checks if a collection defines aws variables.

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

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

### Usage

    .source_collections(source)

    .source_access_test(source, collection, ...)

    .source_collection_aws(source, collection)

    .source_collection_aws_check(source, collection)

    .source_collection_check(source, collection)

    .source_collection_name(source, collection)

### Arguments

`source` | A `character` value referring to a valid data source.
`collection` | A `character` value referring to a collection of the source.

### 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_aws()` returns a named `list` with AWS environment variables.

`.source_collection_aws_check()` returns `NULL` if no error occurs.

`.source_collection_check()` returns `NULL` if no error occurs.

`.source_collection_name()` returns a `character`.

[Package sits version 0.14.1 Index]