Description Usage Arguments Details Value References Examples
View source: R/agronomic-values.R
agronomic_values_area
pulls agronomic data from aWhere's API based on a data.frame of lat/lon, polygon or extent
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | agronomic_values_area(
polygon,
day_start,
day_end,
propertiesToInclude = "",
accumulation_start_date = "",
gdd_method = "standard",
gdd_base_temp = 10,
gdd_min_boundary = 10,
gdd_max_boundary = 30,
numcores = 2,
bypassNumCallCheck = FALSE,
returnSpatialData = FALSE,
verbose = TRUE,
maxTryCount = 3,
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 |
propertiesToInclude |
character vector of properties to retrieve from API. Valid values are accumulations, gdd, pet, ppet, accumulatedGdd, accumulatedPrecipitation, accumulatedPet, accumulatedPpet (optional) |
accumulation_start_date |
Allows the user to start counting accumulations from before the specified start date (or before the planting date if using the most recent planting). Use this parameter to specify the date from which you wish to start counting, in the form: YYYY-MM-DD. The daily values object will still only return the days between the start and end date. This date must come before the start date. (optional) |
gdd_method |
There are variety of equations available for calculating growing degree-days. Valid entries are: 'standard', 'modifiedstandard', 'min-temp-cap', 'min-temp-constant' See the API documentation for a description of each method. The standard method will be used if none is specified. (character - optional) |
gdd_base_temp |
The base temp to use for the any of the GDD equations. The default value of 10 will be used if none is specified. (optional) |
gdd_min_boundary |
The minimum boundary to use in the selected GDD equation. The behavior of this value is different depending on the equation you're using The default value of 10 will be used if none is specified. (optional) |
gdd_max_boundary |
The max boundary to use in the selected GDD equation. The behavior of this value is different depending on the equation you're using. The default value of 30 will be used if none is specified. (optional) |
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 agronomic data on GDDs, potential evapotranspiration (PET), Precipitation over potential evapotranspiration (P/PET), accumulated GDDs, accumulated precipitation, accumulated PET, and accumulated P/PET. Default units are returned by the API.
Agronomic Values are calculated numbers that can be used to show the agronomic status of a field or crop. These figures can be used, for example, to track and predict plant growth or identify water stress. Accumulated values allow growers to easily identify how the weather has been over the season. Both sets of data are commonly used on small and large farms alike. This is a very flexible API that supports a wide variety of configurations to get exactly the data you want as efficiently as possible.
The polygon should be either a SpatialPolygons object or a well-known text character string or an extent.
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. Furthermore, because this function can take as input locations that may be in different timezones, it is the responsibility of the user to either ensure that the date range specified is valid for all relevant locations or to break the query into pieces.
data.frame of requested data for dates requested
https://docs.awhere.com/knowledge-base-docs/agronomic-values-accumulations-by-geolocation/
1 2 3 4 5 | ## Not run: agronomic_values_area(polygon = raster::getData('GADM', country = "Gambia", level = 0, download = T),
,day_start = '2018-04-28'
,day_end = '2018-05-01'
,numcores = 2)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.