forecasts_latlng: forecasts_latlng

Description Usage Arguments Details Value References Examples

View source: R/forecasts.R

Description

forecasts_latlng pulls historical weather data from aWhere's API based on latitude & longitude

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
forecasts_latlng(
  latitude,
  longitude,
  day_start = as.character(Sys.Date()),
  day_end = "",
  block_size = 1,
  useLocalTime = TRUE,
  returnOnlySoilVars = FALSE,
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

Arguments

latitude

the latitude of the requested location (double)

longitude

the longitude of the requested locations (double)

day_start

character string of the first day for which you want to retrieve data, in the form: YYYY-MM-DD Defaults to system date if left blank. (optional)

day_end

character string of the last day for which you want to retrieve data, in form: YYYY-MM-DD Returns all available forecast if left blank. (optional)

block_size

Integer value that corresponds to the number of hours to include in each time block. Defaults to a 1 hour block. This value must divide evenly into 24. (integer - optional)

useLocalTime

whether the data specified is the date specified at the location where data is being requested from or at UTC = 0. Default is TRUE

keyToUse

aWhere API key to use. For advanced use only. Most users will not need to use this parameter (optional)

secretToUse

aWhere API secret to use. For advanced use only. Most users will not need to use this parameter (optional)

tokenToUse

aWhere API token to use. For advanced use only. Most users will not need to use this parameter (optional)

apiAddressToUse

Address of aWhere API to use. For advanced use only. Most users will not need to use this parameter (optional)

Details

This function returns today's forecast plus the forecast for up to 7 more days. Forecasts are available in many sizes of hourly blocks, from hourly to daily. The data this function returns is Min/Max Temperature, Precipitation Amount, Chance of Precipitation, Max Humidity, Relative Humidity, Solar Radiation, Average Wind Speed, Max Windspeed, Percentage of Sky Covered by Clouds, and Percentage of Clear Sky for the location specified by latitude and longitude. Default units are returned by the API. Latitude and longitude must be in decimal degrees.

Note that when block_size = 1 the fields min/max relative humidity and min/max wind will be NA

The Weather APIs provide access to aWhere's agriculture-specific Weather Terrain system, and allows retrieval and integration of data across all different time ranges long term normals, daily observed, current weather, and forecasts. These APIs are designed for efficiency, allowing you to customize the responses to return just the attributes you need.

Note about dates: The system does not adjust for any difference in dates between the location of the user and where data is being requested from. It is the responsibility of the user to ensure a valid date range is specified given any differences in timezone. These differences can have implications for whether a given date should be requested from the daily_observed functions or the forecast functions

Value

data.frame of requested data for dates requested

References

https://docs.awhere.com/knowledge-base-docs/forecast-weather-by-geolocation/

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: forecasts_latlng(latitude = 39.8282
                          ,longitude =  -98.5795
                          ,day_start = as.character(Sys.Date())
                          ,day_end = as.character(Sys.Date() + 5)
                          ,block_size = 12)
         forecasts_latlng(latitude = 19.328489
                          ,longitude = -99.145681
                          ,day_start = as.character(Sys.Date())
                          ,block_size = 4)
## End(Not run)

aWhereAPI/aWhere-R-Library documentation built on Nov. 5, 2021, 3:35 a.m.