openweather_series_observations: Get observations of a Open Weather Map Series

Description Usage Arguments Value

Description

Given the City ID, return observations of the series as a 'tibble' object. 'openweather' is an alieas for 'openweather_series_observations()'.

Usage

1
2
3
4
5
6
7
openweather_series_observations(id = NULL, type = NULL, cnt = NULL,
  units = NULL, aggregation_method = NULL, limit = NULL,
  sort_order = NULL, realtime_start = NULL, realtime_end = NULL)

openweather(id = NULL, type = NULL, cnt = NULL, units = NULL,
  aggregation_method = NULL, limit = NULL, sort_order = NULL,
  realtime_start = NULL, realtime_end = NULL)

Arguments

id

A string ID for the Open Weather series. _Required parameter_.

type

A string ID for the type of weather data to pull. _Required parameter_. * '"today"' for current days weather * '"forecast"' for the 14 day forecast * '"forecast3h"' forcast at 3 hour intervales.

units

* '"i"' Imperial: Fahrenheit for temperature and miles/hour for wind speed * '"k"' Default: Kelvin for temp and meter/sec for wind speed _Default_ * '"m"' Metric: Celsius for temp and meter/sec for wind speed

aggregation_method

A string representing the aggregation method used for frequency aggregation. This parameter has no affect is 'frequency' is not set. Possible values are: * '"avg"' for average * '"sum"' for sum * '"eop"' for end of period value

limit

An integer limit on the maximum number of results to return. Defaults to '100000', the maximum.

sort_order

A string representing the order of the resulting series. Possible values are: '"asc"' (default), and '"desc"'.

realtime_start

A 'Date' indicating the start of the real-time period. Defaults to today's date.

realtime_end

A 'Date' indicating the end of the real-time period. Defaults to today's date.

Value

A 'tibble' object with observation dates and values.


alexhallam/OpenWeatherPull documentation built on May 6, 2019, 7:02 p.m.