rnoaa (version 0.2.0)

ncdc_datatypes: Get possible data types for a particular dataset

Description

From the NOAA API docs: Describes the type of data, acts as a label. If it's 64 degrees out right now, then the data type is Air Temperature and the data is 64.

Usage

ncdc_datatypes(datasetid = NULL, datatypeid = NULL, datacategoryid = NULL,
  stationid = NULL, locationid = NULL, startdate = NULL, enddate = NULL,
  sortfield = NULL, sortorder = NULL, limit = 25, offset = NULL,
  callopts = list(), token = NULL, dataset = NULL, page = NULL,
  filter = NULL)

Arguments

datatypeid

Accepts a valid data type id or a chain of data type ids in a comma-separated vector. Data returned will contain all of the data type(s) specified (optional)

locationid

Accepts a valid location id or a chain of location ids in a comma-separated vector. Data returned will contain data for the location(s) specified (optional)

stationid

Accepts a valid station id or a chain of of station ids in a comma-separated vector. Data returned will contain data for the station(s) specified (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)

datasetid

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

startdate

(optional) Accepts valid ISO formated date (yyyy-mm-dd) or date time (YYYY-MM-DDThh:mm:ss). Data returned will have data after the specified date. The date range must be less than 1 year.

enddate

(optional) Accepts valid ISO formated date (yyyy-mm-dd) or date time (YYYY-MM-DDThh:mm:ss). Data returned will have data before the specified date. The date range must be less than 1 year.

dataset

THIS IS A DEPRECATED ARGUMENT. See datasetid.

page

THIS IS A DEPRECATED ARGUMENT. There is no equivalent argument in v2 of the NOAA API.

filter

THIS IS A DEPRECATED ARGUMENT. There is no equivalent argument in v2 of the NOAA API.

datacategoryid

Optional. Accepts a valid data category id or a chain of data category ids seperated by ampersands (although it is rare to have a data type with more than one data category). Data types returned will be associated with the data category(ies) specified

Value

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

Examples

## Not run: ------------------------------------
# # Fetch available data types
# ncdc_datatypes()
# 
# # Fetch more information about the ACMH data type id
# ncdc_datatypes(datatypeid="ACMH")
# 
# # Fetch data types with the air temperature data category
# ncdc_datatypes(datacategoryid="TEMP", limit=56)
# 
# # Fetch data types that support a given set of stations
# ncdc_datatypes(stationid=c('COOP:310090','COOP:310184','COOP:310212'))
## ---------------------------------------------