CDSE (version 0.2.1)

GetQueryables: Get CQL2 parameters for a collection

Description

Returns a list of variable terms that can be used in CQL2 expressions to filter the collection catalog search.

Usage

GetQueryables(
  collection,
  as_data_frame = TRUE,
  client,
  token,
  url = getOption("CDSE.catalog_url")
)

Value

A list or a data.frame.

Arguments

collection

character indicating the collection for which the parameters are queried. Must be one of the collections returned by GetCollections.

as_data_frame

logical indicating if the result should be returned as data frame. Default: TRUE

client

OAuth client object to use for authentication.

token

OAuth token character string to use for authentication.

Exactly one of either client or token must be specified. It is recommended to use client.

url

character indicating the STAC catalog search endpoint. Default: Copernicus Data Space Ecosystem STAC endpoint

Details

If no parameters found, a NULL value or 0-row data.frame is returned.

See Also

GetCollections, SearchCatalog

Examples

if (FALSE) {
GetQueryables("sentinel-2-l2a", client = OAuthClient)
}