forecasts_area: forecasts_area
In aWhereAPI/aWhere-R-Library: API calls for aWhere API

Description Usage Arguments Details Value References Examples

forecasts_area pulls forecasted weather data from aWhere's API based on a data.frame of lat/lon, polygon or extent

forecasts_area(
  polygon,
  day_start = as.character(Sys.Date()),
  day_end = "",
  block_size = 1,
  useLocalTime = TRUE,
  numcores = 2,
  bypassNumCallCheck = FALSE,
  returnSpatialData = FALSE,
  verbose = TRUE,
  maxTryCount = 3,
  returnOnlySoilVars = FALSE,
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

`polygon`	either a data.frame with column names lat/lon, SpatialPolygons object, well-known text string, or extent from raster package. If the object contains multiple polygons, the union of them is used. Information from each individal polygon can be retrieved by returning spatial data and using the over function from the sp package
`day_start`	character string of the first day for which you want to retrieve data, in the form: YYYY-MM-DD
`day_end`	character string of the last day for which you want to retrieve data, in the form: YYYY-MM-DD
`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
`numcores`	number of cores to use in parallel loop. To check number of available cores: parallel::detectCores() If you receive an error regarding the speed you are making calls, reduce this number
`bypassNumCallCheck`	set to TRUE to avoid prompting the user to confirm that they want to begin making API calls
`returnSpatialData`	returns the data as a SpatialPixels object. Can be convered to raster with the command raster::stack NOTE: if multiple days worth of data is returned, it is necessary to subset to specific day for working with as spatial data (sp package: optional)
`verbose`	Set to TRUE tp print messages to console about state of parallization call. Typically only visible if run from console and not GUI
`maxTryCount`	maximum number of times a call is repeated if the the API returns an error. Random pause between each call
`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)

This function returns today's forecast plus the forecast for up to 15 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

data.frame of requested data for dates requested

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

## Not run: forecasts_area(polygon = raster::getData('GADM', country = "Gambia", level = 0, download = T),
                        ,day_start = as.character(Sys.Date())
                        ,day_end = as.character(Sys.Date() + 5)
                        ,block_size = 12)
                        ,numcores = 2)
## End(Not run)