rnoaa (version 0.2.0)

ncdc_locs_cats: Get metadata about NOAA location categories.

Description

Location categories are groupings of similar locations.

Usage

ncdc_locs_cats(datasetid = NULL, locationcategoryid = NULL,
  startdate = NULL, enddate = NULL, sortfield = NULL, sortorder = NULL,
  limit = 25, offset = NULL, callopts = list(), token = NULL)

Arguments

datasetid

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

locationcategoryid

A valid location id or a chain of location category ids in a comma-separated vector. Locations returned will be in the location category(ies) specified

startdate

A 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 list containing metadata and the data, or a single data.frame.

Details

Locations can be a specific latitude/longitude point such as a station, or a label representing a bounding area such as a city.

Examples

## Not run: ------------------------------------
# # All location categories, first 25 results
# ncdc_locs_cats()
# 
# # Find locations with category id of CLIM_REG
# ncdc_locs_cats(locationcategoryid='CLIM_REG')
# 
# # Displays available location categories within GHCN-Daily dataset
# ncdc_locs_cats(datasetid='GHCND')
# 
# # Displays available location categories from start date 1970-01-01
# ncdc_locs_cats(startdate='1970-01-01')
## ---------------------------------------------