espa_ordering_listorders: espa_ordering_listorders

Description Usage Arguments Details Value Author(s) References Examples

Description

R wrapper for ESPA Ordering System List Orders API.

Usage

1
2
espa_ordering_listorders(email = NULL, usgs_eros_username, usgs_eros_password,
  ordernums_only = F, verbose = F)

Arguments

email

Character. email address of a user. Only neccessary if you want to list orders from a different user.

usgs_eros_username

Character. Your USGS registration username. You can register for an account at https://espa.cr.usgs.gov

usgs_eros_password

Character. Your USGS registration password. WARNING: USING THIS WITH R IS NOT PARTICULARLY SECURE.

ordernums_only

Logical. Returns the orders in a nearly formatted character vector. Default=F.

verbose

Logical. Verbose execution? Default=F.

Details

Lists orders for the authenticated user or a supplied email.

Value

(ordernums_only=F) list or (ordernums_only=T) character vector of orders for a given user.

Author(s)

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

References

https://github.com/USGS-EROS/espa-api#apiOrdersEmail

Examples

1
2
3
4
5
6
7
8
9
## Not run:  
# Get status for the authenticated user:
espa_ordering_listorders(usgs_eros_username="myusername",usgs_eros_password="mypassword")

# Get status for a different user based on their email:
espa_ordering_listorders(email="my@email.com",usgs_eros_username="myusername",
		usgs_eros_password="mypassword")

## End(Not run)

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