espa_inventory_metadata: espa_inventory_metadata

Description Usage Arguments Details Value Author(s) References See Also Examples

Description

R wrapper for USGS/EROS Inventory Service Scene Metadata API.

Usage

1
2
espa_inventory_metadata(datasetName, entityIds, apiKey, node = "EE",
  verbose = F)

Arguments

datasetName

Character. Identifies the dataset Use the datasetName from datasets response. See https://mapbox.github.io/usgs/reference/catalog/hdds.html for a list of valid datasetNames.

entityIds

Character. Identifies multiple scenes to remove.

apiKey

Character. Users API Key/Authentication Token, obtained from espa_inventory_login request.

node

Character. Determines the dataset catalog to use. Default="EE", probably never needs to be changed.

verbose

Logical. Verbose execution? Default=F.

Details

The use of the metadata request is intended for those who have acquired scene IDs from a different source. It will return the same metadata that is available via the search request.

Value

List of metadata.

Author(s)

Jonathan A. Greenberg (espa-tools@estarcion.net) (wrapper) and USGS ESPA Developers (API and documentation)

References

https://earthexplorer.usgs.gov/inventory/documentation/json-api#metadata

See Also

espa_inventory_login,espa_inventory_get_api

Examples

1
2
3
4
5
6
## Not run:  
# Get API KEY (required EROS username/password): 
apiKey=espa_inventory_login("myusername","mypassword")
espa_inventory_metadata(datasetName="LANDSAT_8",entityIds=c("LC80130292014100LGN00"),apiKey=apiKey)

## End(Not run)

espa.tools documentation built on May 2, 2019, 5:54 p.m.