agronomic_norms_fields: agronomic_norms_fields

Description Usage Arguments Details Value References Examples

View source: R/agronomic-norms.R

Description

agronomic_norms_fields pulls agronomic norm data from aWhere's API based on field id

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
agronomic_norms_fields(
  field_id,
  month_day_start,
  month_day_end,
  year_start,
  year_end,
  propertiesToInclude = "",
  exclude_years = NULL,
  accumulation_start_date = "",
  gdd_method = "standard",
  gdd_base_temp = 10,
  gdd_min_boundary = 10,
  gdd_max_boundary = 30,
  includeFeb29thData = TRUE,
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

Arguments

field_id

the field_id associated with the location for which you want to pull data. Field IDs are created using the create_field function. (string)

month_day_start

character string of the first month and day for which you want to retrieve data, in the form: MM-DD. This is the start of your date range. e.g. '07-01' (July 1) (required)

month_day_end

character string of the last month and day for which you want to retrieve data, in the form: MM-DD. This is the end of your date range. e.g. '07-01' (July 1) (required)

year_start

character string of the starting year (inclusive) of the range of years for which you're calculating norms, in the form YYYY. e.g., 2008 (required)

year_end

character string of the last year (inclusive) of the range of years for which you're calculating norms, in the form YYYY. e.g., 2015 (required)

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)

includeFeb29thData

Whether to keep data from Feb 29th on leap years. Because weather/agronomics summary statistics are calculated via the calendar date and 3 years are required to generate a value, data from this date is more likely to be NA. ALlows user to drop this data to avoid later problems (defaults to 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)

exclude_year

Year or years which you'd like to exclude from your range of years on which to calculate norms. To exclude multiple years, provide a vector of years. You must include at least three years of data with which to calculate the norms. (numeric, optional)

Details

This function allows you to calculate the averages for agronomic attributes across any range of years for which data are available. The data pulled includes norms for growing degree days (GDDs), potential evapotranspiration (PET), Precipitation over potential evapotranspiration (P/PET), accumulated GDDs, accumulated precipitation, accumulated PET, and accumulated P/PET, along with the standard deviations for these variables. The data pulled is for the field id identified. Default units are returned by the API.

The data returned in this function allow you to compare this year or previous years to the long-term normals, calculated as the average of those agronomic conditions on that day in that location over the years specified.

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

dataframe of requested data for dates requested

References

https://docs.awhere.com/knowledge-base-docs/historical-agronomic-norms/

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: agronomic_norms_fields(field_id = 'field_test'
                                ,month_day_start = '07-01'
                                ,month_day_end = '07-10'
                                ,year_start = 2008
                                ,year_end = 2016
                                ,exclude_years = "2010"
                                ,accumulation_start_date = ''
                                ,gdd_method = 'standard'
                                ,gdd_base_temp = 10
                                ,gdd_min_boundary = 10
                                ,gdd_max_boundary = 30)
## End(Not run)

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