rnoaa (version 0.2.0)

ncdc_datacats: Get possible data categories for a particular datasetid, locationid, stationid, etc.

Description

Data Categories represent groupings of data types.

Usage

ncdc_datacats(datasetid = NULL, datacategoryid = NULL, stationid = NULL,
  locationid = NULL, startdate = NULL, enddate = NULL, sortfield = NULL,
  sortorder = NULL, limit = 25, offset = NULL, callopts = list(),
  token = NULL)

Arguments

datasetid

Accepts a single valid dataset id. Data returned will be from the dataset specified, see datasets() (required)

datacategoryid

A valid data category id. Data types returned will be associated with the data category(ies) specified

locationid

Accepts a valid location id. Data returned will contain data for the location(s) specified (optional)

stationid

Accepts a valid station id. Data returned will contain data for the station(s) specified (optional)

startdate

Accepts valid ISO formated date (yyyy-mm-dd). Data returned will have data after the specified date. Paramater can be use independently of enddate (optional)

enddate

Accepts valid ISO formated date (yyyy-mm-dd). Data returned will have data before the specified date. Paramater can be use independently of startdate (optional)

sortfield

The field to sort results by. Supports id, name, mindate, maxdate, and datacoverage fields (optional)

sortorder

Which order to sort by, asc or desc. Defaults to asc (optional)

limit

Defaults to 25, limits the number of results in the response. Maximum is 1000 (optional)

offset

Defaults to 0, used to offset the resultlist (optional)

token

This must be a valid token token supplied to you by NCDC's Climate Data Online access token generator. (required) Get an API key (=token) at http://www.ncdc.noaa.gov/cdo-web/token. You can pass your token in as an argument or store it in your .Rprofile file with an entry like

• options("noaakey" = "your-noaa-token")

callopts

Further arguments passed on to the API GET call. (optional)

Value

A data.frame for all datasets, or a list of length two, each with a data.frame.

Details

Note that calls with both startdate and enddate don't seem to work, though specifying one or the other mostly works.

References

Vignette at http://ropensci.org/tutorials/rnoaa_tutorial.html

Examples

## Not run: ------------------------------------
# ## Limit to 41 results
# ncdc_datacats(limit=41)
# 
# ## Single data category
# ncdc_datacats(datacategoryid="ANNAGR")
# 
# ## Fetch data categories for a given set of locations
# ncdc_datacats(locationid='CITY:US390029')
# ncdc_datacats(locationid=c('CITY:US390029', 'FIPS:37'))
# 
# ## Data categories for a given date
# ncdc_datacats(startdate = '2013-10-01')
## ---------------------------------------------