get_coop: Wrapper of rnoaa::coops_search that allows retrieval of more...

In adamdsmith/nrsmisc: Miscellaneous functions for work

Description

This function is particularly useful for retrieving tide/water level data. Other functions in this package (e.g., get_wx or get_wx_ACIS may be better suited for basic meteorological data. All the products and options available at coops_search are available here except the ability to pass additional options to Curl. We also add add optional start and end date formats to be more consistent with other functions in this package. However, calls to coops_search without Curl options should work seemlessly with a call to get_coop. See example. Note, however, we return only the data.frame data component returned by coops_search

Usage

get_coop(begin_date = NULL, end_date = NULL, station_name = NULL,
  product, datum = NULL, units = "metric", time_zone = "gmt",
  application = "rnoaa", start = NULL, end = NULL, verbose = TRUE)

Arguments

begin_date	(numeric) Date in yyyymmdd format. One of begin_date or start is required.
end_date	(numeric) Date in yyyymmdd format. One of end_date or end is required.
station_name	(numeric) Required station name/number. See https://tidesandcurrents.noaa.gov/map/ to locate station name and view what data product might be available.
product	(character) Specify the data type. See Details for options. Required
datum	(character) See below for Details. Required for all water level products.
units	(character) One of 'metric' (default) or 'english' (imperial)
time_zone	(character) Time zone, one of 'gmt' (default), 'lst', or 'lst_ldt'. See details at coops_search.
application	(character) If called within an external package, set to the name of your organization. Optional.
start	character or Date scalar of start date ("YYYY-MM-DD")
end	character or Date scalar of end date ("YYYY-MM-DD")
verbose	(logical) print messages while processing requests?

Details

Options for the product paramater. Not all available at every station. One of:

• water_level - Preliminary or verified water levels, depending on availability

• air_temperature - Air temperature as measured at the station

• water_temperature - Water temperature as measured at the station

• wind - Wind speed, direction, and gusts as measured at the station

• air_pressure - Barometric pressure as measured at the station

• air_gap - Air Gap (distance between a bridge and the water's surface) at the station

• conductivity - The water's conductivity as measured at the station

• visibility - Visibility from the station's visibility sensor. A measure of atmospheric clarity

• humidity - Relative humidity as measured at the station

• salinity - Salinity and specific gravity data for the station

• one_minute_water_level - One minute water level data for the station

• predictions - 6 minute predictions water level data for the station

• hourly_height - Verified hourly height water level data for the station

• high_low - Verified high/low water level data for the station

• daily_mean - Verified daily mean water level data for the station

• monthly_mean - Verified monthly mean water level data for the station

• datums - datums data for the stations

• currents - Currents data for currents stations

Options for the datum parameter. Not all available for every station. One of:

• MHHW - Mean higher high water

• MHW - Mean high water

• MTL - Mean tide level

• MSL - Mean sea level

• MLW - Mean low water

• MLLW - Mean lower low water

• NAVD - North American Vertical Datum

• STND - Station datum

Value

A data.frame with data or NULL if no data is found

Examples

## Not run: 
# Two months of water level data at Vaca Key (8723970)
# Fails with coops_search because query range is too long
coops_search(begin_date = 20140927, end_date = 20141115,
             station_name = 8723970, datum = "stnd",
             product = "water_level")
# Works with get_coop with exact same argument order
get_coop(begin_date = 20140927, end_date = 20141115,
         station_name = 8723970, datum = "stnd",
         product = "water_level")

## End(Not run)

adamdsmith/nrsmisc documentation built on Aug. 13, 2019, 2:14 p.m.