rnoaa (version 0.1.0)

noaa: Get NOAA data for any combination of dataset, datatype, station, location, and/or location type.

Description

From the NOAA API docs: "The data endpoint is used for actually fetching the data."

Usage

noaa(datasetid = NULL, datatypeid = NULL, stationid = NULL,
  locationid = NULL, startdate = NULL, enddate = NULL, sortfield = NULL,
  sortorder = NULL, limit = 25, offset = NULL, callopts = list(),
  token = NULL, dataset = NULL, datatype = NULL, station = NULL,
  location = NULL, locationtype = NULL, page = NULL, year = NULL,
  month = NULL, day = NULL, results = NULL)

Arguments

datasetid

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

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)

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 i

callopts

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

dataset

THIS IS A DEPRECATED ARGUMENT. See datasetid.

datatype

THIS IS A DEPRECATED ARGUMENT. See datatypeid.

station

THIS IS A DEPRECATED ARGUMENT. See stationid.

location

THIS IS A DEPRECATED ARGUMENT. See locationid.

locationtype

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

page

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

year

THIS IS A DEPRECATED ARGUMENT. Use combination of startdate and enddate arguments.

month

THIS IS A DEPRECATED ARGUMENT. Use combination of startdate and enddate arguments.

day

THIS IS A DEPRECATED ARGUMENT. Use combination of startdate and enddate arguments.

results

THIS IS A DEPRECATED ARGUMENT. See limit.

Value

• A list of length two, a slot of metadata (meta), and a slot for data (data). The meta slot is a list of metadata elements, and the data slot is a data.frame, possibly of length zero if no data is found.

Details

Note that NOAA API calls can take a long time depending on the call. If you get a error try setting startdate and enddate explicitly. The NOAA API doesn't perform well with very long timespans, and will time out and make you angry - beware.

Examples

noaa(datasetid='GHCND', locationid = 'FIPS:02', startdate = '2010-05-01',
enddate = '2010-05-31', limit=5)

# GHCN-Daily data since Septemer 1 2013
noaa(datasetid='GHCND', startdate = '2013-11-09')

# Normals Daily GHCND:USW00014895 dly-tmax-normal data
noaa(datasetid='NORMAL_DLY', stationid='GHCND:USW00014895', startdate = '2010-05-01',
enddate = '2010-05-10')

# Dataset, and location in Australia
noaa(datasetid='GHCND', locationid='FIPS:AS', limit=5)

# Dataset, location and datatype
noaa(datasetid='PRECIP_HLY', locationid='ZIP:28801', datatypeid='HPCP', limit=5)

# Dataset, location, station and datatype
noaa(datasetid='PRECIP_HLY', locationid='ZIP:28801', stationid='COOP:310301',
datatypeid='HPCP', limit=5)

# Dataset, location, and datatype
noaa(datasetid='GHCND', locationid='FIPS:BR', datatypeid='PRCP', limit=5)

# Normals Daily GHCND dly-tmax-normal data
noaa(datasetid='NORMAL_DLY', datatypeid='dly-tmax-normal', limit=5)

# Normals Daily GHCND:USW00014895 dly-tmax-normal
noaa(datasetid='NORMAL_DLY', stationid='GHCND:USW00014895',
datatypeid='dly-tmax-normal', limit=5)

# Hourly Precipitation data for ZIP code 28801
noaa(datasetid='PRECIP_HLY', locationid='ZIP:28801', datatypeid='HPCP', limit=5)