espa_inventory_datasets: espa_inventory_datasets

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

Description

R wrapper for USGS/EROS Inventory Service Dataset Search API.

Usage

1
2
3
espa_inventory_datasets(datasetName = NULL, spatialFilter = NULL,
  temporalFilter = NULL, lowerLeft = NULL, upperRight = NULL,
  startDate = "1920-01-07", endDate = Sys.Date(), apiKey, verbose = F)

Arguments

datasetName

Character. Used as a filter with wildcards inserted at the beginning and the end of the supplied value. See https://mapbox.github.io/usgs/reference/catalog/hdds.html for a list of valid datasetNames.

spatialFilter

TBD

temporalFilter

TBD

lowerLeft

List. When used in conjunction with upperRight, creates a bounding box to search spatially. Should be a list of form list(latitude=XX,longitude=XX)

upperRight

List. When used in conjunction with lowerLeft, creates a bounding box to search spatially. Should be a list of form list(latitude=XX,longitude=XX)

startDate

Character. Used to search datasets temporally for possible dataset coverage. ISO 8601 Formatted Date. Time portion is ignored.

endDate

Character. Used to search datasets temporally for possible dataset coverage. ISO 8601 Formatted Date. Time portion is ignored.

apiKey

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

verbose

Logical. Verbose execution? Default=F.

Details

This method is used to find datasets available for searching. By passing no parameters except node, all available datasets are returned. Additional parameters such as temporal range and spatial bounding box can be used to find datasets that provide more specific data. The dataset name parameter can be used to limit the results based on matching the supplied value against the public dataset name with assumed wildcards at the beginning and end.

Value

List of metadata filter fields for datasets available for searching.

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#datasets

See Also

espa_inventory_login,espa_inventory_get_api

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run:  
# Get API KEY (required EROS username/password): 
apiKey=espa_inventory_login("myusername","mypassword")
espa_inventory_datasets(datasetName="LANDSAT_8",
   lowerLeft=list(latitude=44.60847,"longitude"=-99.69639),
   upperRight=list(latitude=44.60847,"longitude"=-99.69639),
   startDate="2014-10-01",endDate="2014-10-01",
   apiKey=apiKey)

## End(Not run)

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