Package rwunderground

Transcription

1 Type Package Package rwunderground Title R Interface to Weather Underground API Version Date Author Alex Shum <alex@alshum.com> November 12, 2017 Maintainer Eric Hare <eric@omnianalytics.io> Tools for getting historical weather information and forecasts from wunderground.com. Historical weather and forecast data includes, but is not limited to, temperature, humidity, windchill, wind speed, dew point, heat index. Additionally, the weather underground weather API also includes information on sunrise/sunset, tidal conditions, satellite/webcam imagery, weather alerts, hurricane alerts and historical high/low temperatures. URL BugReports License GPL (>= 2) Imports httr, dplyr, countrycode, lubridate LazyData TRUE RoxygenNote NeedsCompilation no Repository CRAN Date/Publication :59:00 UTC R topics documented: alerts almanac as.numeric.nonempty astronomy base_url

2 2 alerts build_url conditions current_hurricane dst_posixct dst_repeat_starttime encode_na forecast10day forecast3day geolookup get_api_ has_api_ history history_daily history_range hourly hourly10day is_fall_back_day is_valid_airport is_valid_territory list_airports list_countries list_states lookup_airport lookup_country_code measurement_exists nonempty planner tide satellite set_api_ set_ stop_for_error tide webcam wunderground_request yesterday Index 29 alerts Weather Alerts for United States and Europe Weather Alerts for United States and Europe

3 almanac 3 alerts(, = get_api_(), = FALSE, _JSON = FALSE, = TRUE) _JSON set by set_ weather underground API if TRUE return entire alert as JSON A string containing alert type,, start time and expiration. alerts(set_(territory = "Hawaii", city = "Honolulu")) alerts(set_(airport_code = "SEA")) alerts(set_(zip_code = "90210")) alerts(set_(territory = "IR", city = "Tehran")) almanac Average and record high and low temperatures for current date going back as far as weather underground has data or from the national weather service going back 30 years. Average and record high and low temperatures for current date going back as far as weather underground has data or from the national weather service going back 30 years. almanac(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE) use_metric set by set_ Metric or imperial units weather underground API

4 4 astronomy tbl_df with columns:, airport, avg_high, record high, avg_low, record low. almanac(set_(territory = "Hawaii", city = "Honolulu")) almanac(set_(airport_code = "SEA")) almanac(set_(zip_code = "90210")) almanac(set_(territory = "IR", city = "Tehran")) as.numeric.nonempty as.numeric with special handling for length 0 (NULL) objects as.numeric with special handling for length 0 (NULL) objects ## S3 method for class 'nonempty' as.numeric(x) x the object to cast as numeric value of type double astronomy Moon phase, sunrise and sunset times for today. Moon phase, sunrise and sunset times for today. astronomy(, = get_api_(), = FALSE, = TRUE)

5 base_url 5 set by set_ weather underground API tbl_df with:, moon phase, percent visible, moon rise and set times, sun rise and set times. astronomy(set_(territory = "Hawaii", city = "Honolulu")) astronomy(set_(airport_code = "SEA")) astronomy(set_(zip_code = "90210")) astronomy(set_(territory = "IR", city = "Tehran")) base_url Base URL for wunderground API Base URL for wunderground API base_url() base wunderground URL

6 6 conditions build_url Build wunderground request URL Build wunderground request URL build_url( = get_api_(), request_type, date, ) request_type date wunderground API request type TODO::list all request_types Date, only applicable for history requests set by set_ conditions Current conditions including current temperature, weather condition, humidity, wind, feels-like, temperature, barometric pressure, and visibility. Current conditions including current temperature, weather condition, humidity, wind, feels-like, temperature, barometric pressure, and visibility. conditions(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE) use_metric set by set_ Metric or imperial units weather underground API tbl_df with conditions

7 current_hurricane 7 conditions(set_(territory = "Hawaii", city = "Honolulu")) conditions(set_(airport_code = "SEA")) conditions(set_(zip_code = "90210")) conditions(set_(territory = "IR", city = "Tehran")) current_hurricane Current hurricane - within the US only. Note: all times in eastern Current hurricane - within the US only. Note: all times in eastern current_hurricane( = get_api_(), use_metric = FALSE, = FALSE, = TRUE) use_metric weather underground API Metric or imperial units Hurricane info current_hurricane()

8 8 dst_repeat_starttime dst_posixct Return POSIXct time from 7 variables. In s with a Daylight Saving/Standard time change that occurs twice annually, the year has one 23 hour day and one 25 hour day, if by day we mean "an ordered set of all instants in time which are assigned the same date". In the US/Los_Angeles timezone, there is one day in the spring where are no valid times between the moment before 02:00:00 and 03:00:00. Similarly, there is one day in the fall where there are two instants described by all times between 01:00:00 and 01:59:59, first as a set of PDT times, then as a set of PST times. as.posixct() doesn t handle this case well. Times inside this region are assigned to DST until the sequence of clock times has a time which is the same or earlier than its predecessor, and all subsequent ambiguous times are assigned to Standard Time. dst_posixct(y, m, d, hr, mn, sec, tz) y m d hr mn sec tz vector of years vector of months vector of days vector of hours vector of minutes vector of seconds vector of timezones POSIXct time assuming vectors sorted by true chronological order, at least for the hour that "occurs twice", once with Daylight Time, then again with Standard Time. If there are no nonmonotonicities in the times, all times in this hour will be assumed to be Daylight Time. dst_repeat_starttime Find the text to POSIXct ambiguous interval. Assumes that DST transitions happen on hour boundaries, which is true almost everywhere, and that the wall clock shifts back and repeats exactly 1 hour, again true almost everywhere. This code relies on R and the OS to properly manage DST in all timezones.

9 encode_na 9 dst_repeat_starttime(y, m, d, tz) y m d tz the year the month the day the timezone list of two integers betweeen 0000 and 2359, hhmm format. the first integer is the beginning of the interval of clock times which correspond to 2 separate instants of time, the second is the end of that interval. The left endpoint is ambiguous, the right endpoint is not since it maps only to Standard Time. encode_na Processes data.frames and replaces wunderground s -9999/-999 to NAs Processes data.frames and replaces wunderground s -9999/-999 to NAs encode_na(df) df the data.frame to process data.frame with correctly encoded NAs

10 10 forecast3day forecast10day Forecast for the next 10 days. Forecast for the next 10 days. forecast10day(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE) use_metric set by set_ Metric or imperial units weather underground API tbl_df with date (in posix format), high and low temp, conditions, precipitation, rain, snow, max and avg wind speed, max/min and avg humidity forecast10day(set_(territory = "Hawaii", city = "Honolulu")) forecast10day(set_(airport_code = "SEA")) forecast10day(set_(zip_code = "90210")) forecast10day(set_(territory = "IR", city = "Tehran")) forecast3day Forecast for the next 3 days. Forecast for the next 3 days. forecast3day(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE)

11 geolookup 11 use_metric set by set_ Metric or imperial units weather underground API tbl_df with date (in posix format), high and low temp, conditions, precipitation, rain, snow, max and avg wind speed, max/min and avg humidity forecast3day(set_(territory = "Hawaii", city = "Honolulu")) forecast3day(set_(airport_code = "SEA")) forecast3day(set_(zip_code = "90210")) forecast3day(set_(territory = "IR", city = "Tehran")) geolookup Lists nearby weather stations for a given Lists nearby weather stations for a given geolookup(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE) use_metric set by set_ Metric or imperial units weather underground API tbl_df of nearby weather stations with: type, city, state, country, id, lat, lon and dist (in either mi or km)

12 12 has_api_ geolookup(set_(territory = "Hawaii", city = "Honolulu")) geolookup(set_(airport_code = "SEA")) geolookup(set_(zip_code = "90210")) geolookup(set_(territory = "IR", city = "Tehran")) get_api_ Returns the wunderground API Returns the wunderground API get_api_() API get_api_() has_api_ Detects if wunderground API is set Detects if wunderground API is set has_api_() TRUE if API set, otherwise FALSE

13 history 13 history Hourly weather data for specified date. Hourly weather data for specified date. history(, date = " ", use_metric = FALSE, = get_api_(), = FALSE, = TRUE) date use_metric set by set_ Date as YYYYMMDD format Metric or imperial units weather underground API tbl_df with date, temperature, dew point, humidity, wind speed, gust and direction, visibility, pressure, wind chill, heat index, precipitation, condition, fog, rain, snow, hail, thunder, tornado history(set_(territory = "Hawaii", city = "Honolulu"), " ") history(set_(airport_code = "SEA"), " ") history(set_(zip_code = "90210"), " ") history(set_(territory = "IR", city = "Tehran"), " ")

14 14 history_range history_daily Summarized weather data for specified date. Summarized weather data for specified date. history_daily(, date = " ", use_metric = FALSE, = get_api_(), = FALSE, = TRUE) date use_metric set by set_ Date as YYYYMMDD format Metric or imperial units weather underground API tbl_df of summarized weather history_daily(set_(territory = "Hawaii", city = "Honolulu"), " ") history_daily(set_(airport_code = "SEA"), " ") history_daily(set_(zip_code = "90210"), " ") history_daily(set_(territory = "IR", city = "Tehran"), " ") history_range Hourly weather data for specified date range. Hourly weather data for specified date range.

15 hourly 15 history_range(, date_start = " ", date_end = " ", limit = 10, no_api = FALSE, use_metric = FALSE, = get_api_(), = FALSE, = TRUE) date_start date_end limit no_api use_metric set by set_ start date end date Maximum number of API requests per minute, NULL to have no limits bypass API and use URL requests Metric or imperial units weather underground API tbl_df with date, temperature, dew point, humidity, wind speed, gust and direction, visibility, pressure, wind chill, heat index, precipitation, condition, fog, rain, snow, hail, thunder, tornado history_range(set_(territory = "Hawaii", city = "Honolulu"), " ", " ") history_range(set_(airport_code = "SEA"), " ", " ") history_range(set_(zip_code = "90210"), " ", " ") history_range(set_(territory = "IR", city = "Tehran"), " ", " ") hourly Hourly forecast for the next 24 hours. Hourly forecast for the next 24 hours. hourly(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE)

16 16 hourly10day use_metric set by set_ Metric or imperial units weather underground API tbl_df with date, temperature, dew point, condition, wind speed and direction, UV index, humidity, windchill, heat index, real feel, rain, snow, pop, mslp hourly(set_(territory = "Hawaii", city = "Honolulu")) hourly(set_(airport_code = "SEA")) hourly(set_(zip_code = "90210")) hourly(set_(territory = "IR", city = "Tehran")) hourly10day Hourly forecast for the next 10 days. Hourly forecast for the next 10 days. hourly10day(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE) use_metric set by set_ Metric or imperial units weather underground API tbl_df with date, temperature, dew point, condition, wind speed and direction, UV index, humidity, windchill, heat index, real feel, rain, snow, pop, mslp

17 is_fall_back_day 17 hourly10day(set_(territory = "Hawaii", city = "Honolulu")) hourly10day(set_(airport_code = "SEA")) hourly10day(set_(zip_code = "90210")) hourly10day(set_(territory = "IR", city = "Tehran")) is_fall_back_day Check if a date is a "fall back" transition from DST. Check if a date is a "fall back" transition from DST. is_fall_back_day(y, m, d, tz) y m d tz the year the month the day the timezone logical is_valid_airport Checks if airport code is valid Checks if airport code is valid is_valid_airport(name) name Airport code either IATA or ICAO

18 18 list_airports TRUE if valid otherwise FALSE is_valid_territory Checks if country/state is a valid one Checks if country/state is a valid one is_valid_territory(name) name Name of state or country TRUE if valid state or country otherwise FALSE list_airports Returns a data.frame of valid airport codes (ICAO and IATA). This dataset is from the openflights.org airport database. It can be found at org/data.html#airport. This data is provided under the open database license more information can be found here: list_airports() data.frame of airport codes with country and city list_airports()

19 list_countries 19 list_countries Returns a data.frame of valid countries with iso abbreviations and region Returns a data.frame of valid countries with iso abbreviations and region list_countries() data.frame of valid country names with iso codes list_countries() list_states Returns a data.frame of valid states with abbreviations and regions Returns a data.frame of valid states with abbreviations and regions list_states() data.frame of states with abbreviation and region list_states()

20 20 lookup_country_code lookup_airport Lookup airport code (IATA and ICAO code). weatherunderground API might not recognize the IATA/ICAO code for smaller airports. Lookup airport code (IATA and ICAO code). weatherunderground API might not recognize the IATA/ICAO code for smaller airports. lookup_airport(, region = NULL) region string region string data.frame of matching airport name and IATA/ICAO codes lookup_airport("honolulu") lookup_airport("pyongyang") lookup_airport("portland", region = "Los_Angeles") lookup_country_code Lookup ISO country code weatherunderground API doesn t recognize iso codes uniformly for every country.name Lookup ISO country code weatherunderground API doesn t recognize iso codes uniformly for every country.name lookup_country_code(name, region = NULL)

21 measurement_exists 21 name region Name of country Geographic region data.frame of country codes lookup_country_code("korea") lookup_country_code("guinea", region = "Africa") measurement_exists Check if a variable exists for a PWS. If not set the value to Check if a variable exists for a PWS. If not set the value to measurement_exists(x, class = "numeric") x class the value to check a character given the desired class for the variable nonempty return object, or NA for length 0 (NULL) objects return object, or NA for length 0 (NULL) objects nonempty(x) x the object to cast as numeric

22 22 planner value of type double planner Weather summary based on historical information between the specified dates Weather summary based on historical information between the specified dates planner(, use_metric = FALSE, start_date = "0501", end_date = "0531", = get_api_(), = FALSE, = TRUE) use_metric start_date end_date set by set_ Metric or imperial units Start date as MMDD End date as MMDD weather underground API tbl_df planner(set_(territory = "Hawaii", city = "Honolulu"), start_date = "0101", end_date = "0131") planner(set_(territory = "Washington", city = "Seattle"), start_date = "01201", end_date = "1231") planner(set_(territory = "Louisiana", city = "New Orleans"), start_date = "0501", end_date = "0531")

23 tide 23 tide Raw Tidal data with data every 5 minutes for US s Tidal information only available for US cities. Units are in feet. Raw Tidal data with data every 5 minutes for US s Tidal information only available for US cities. Units are in feet. tide(, = get_api_(), = FALSE, = TRUE) set by set_ weather underground API tbl_df with time (epoch) and height tide(set_(territory = "Hawaii", city = "Honolulu")) tide(set_(territory = "Washington", city = "Seattle")) tide(set_(territory = "Louisiana", city = "New Orleans")) satellite Returns image URL for satellite imagery Returns image URL for satellite imagery satellite(, = get_api_(), = FALSE, = TRUE)

24 24 set_api_ set by set_ weather underground API URL to satellite imagery satellite(set_(territory = "Hawaii", city = "Honolulu")) satellite(set_(territory = "Washington", city = "Seattle")) satellite(set_(territory = "Louisiana", city = "New Orleans")) set_api_ Sets the wunderground API Sets the wunderground API set_api_() wunderground API API set_api_("1a2b3c4d")

25 set_ 25 set_ Specifies of request This is a wrapper function that will validate and format strings for requesting data from weather underground. set_(zip_code = NULL, territory = NULL, city = NULL, airport_code = NULL, PWS_id = NULL, lat_long = NULL, autoip = NULL) zip_code territory city airport_code PWS_id lat_long autoip zip code state if in US, otherwise country city name IATA/ICAO airport code personal weather station ID latitude and longitude, as a comma-separated string based on IP formatted and validated string set_(zip_code = "90210") set_(territory = "Hawaii", city = "Honolulu") set_(territory = "Kenya", city = "Mombasa") set_(airport_code = "SEA") set_(pws_id = "KMNCHASK10") set_(lat_long=" , ") set_(autoip = " ") set_()

26 26 tide stop_for_error Detect and stop for any wunderground request errors Detect and stop for any wunderground request errors stop_for_error(httr_parsed_req) httr_parsed_req httr request object tide Tidal information for a within the USA. Tidal information only available for US cities. Units are in feet. Tidal information for a within the USA. Tidal information only available for US cities. Units are in feet. tide(, = get_api_(), = FALSE, = TRUE) set by set_ weather underground API tbl_df with date, height and type tide(set_(territory = "Hawaii", city = "Honolulu")) tide(set_(territory = "Washington", city = "Seattle")) tide(set_(territory = "Louisiana", city = "New Orleans"))

27 webcam 27 webcam Returns s of personal weather stations along with URLs for their webcam images Returns s of personal weather stations along with URLs for their webcam images webcam(, = get_api_(), = FALSE, = TRUE) set by set_ weather underground API tbl_df of weather stations including: handle, id, city, state, country, tz, lat, lon, last updated, image URL and cam URL. webcam(set_(territory = "Hawaii", city = "Honolulu")) webcam(set_(territory = "Iowa", city = "Iowa City")) webcam(set_(territory = "Iraq", city = "Baghdad")) wunderground_request wunderground api requests wunderground api requests wunderground_request(request_type,, date = NULL, = get_api_(), = TRUE)

28 28 yesterday request_type date Request type TODO::list all types s set of set_ Date, only applicable for history requests wunderground API if TRUE print out requested httr request object yesterday Weather data for yesterday Weather data for yesterday yesterday(, use_metric = FALSE, = get_api_(), = FALSE, = TRUE, summary = FALSE) use_metric summary set by set_ Metric or imperial units weather underground API If TRUE return daily summary otherwise hourly data tbl_df with date, temperature, dew point, humidity, wind speed, gust and direction, visibility, pressure, wind chill, heat index, precipitation, condition, fog, rain, snow, hail, thunder, tornado yesterday(set_(territory = "Hawaii", city = "Honolulu")) yesterday(set_(territory = "Iowa", city = "Iowa City")) yesterday(set_(territory = "Iraq", city = "Baghdad")) yesterday(set_(territory = "IR", city = "Tehran"), summary = TRUE)

29 Index alerts, 2 almanac, 3 as.numeric.nonempty, 4 astronomy, 4 base_url, 5 build_url, 6 conditions, 6 current_hurricane, 7 dst_posixct, 8 dst_repeat_starttime, 8 encode_na, 9 planner, 22 tide, 23 satellite, 23 set_api_, 24 set_, 25 stop_for_error, 26 tide, 26 webcam, 27 wunderground_request, 27 yesterday, 28 forecast10day, 10 forecast3day, 10 geolookup, 11 get_api_, 12 has_api_, 12 history, 13 history_daily, 14 history_range, 14 hourly, 15 hourly10day, 16 is_fall_back_day, 17 is_valid_airport, 17 is_valid_territory, 18 list_airports, 18 list_countries, 19 list_states, 19 lookup_airport, 20 lookup_country_code, 20 measurement_exists, 21 nonempty, 21 29