update_field: Update Field

Description Usage Arguments Details Value References Examples

View source: R/update.R

Description

update_field To update details (Farm ID or FieldName) of a particular location in the aWhere API.

Usage

1
2
3
4
5
6
7
8
9
update_field(
  field_id,
  variable_update,
  value_update,
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

Arguments

field_id

the unique field ID for the field you want to update (character string) (required)

variable_update

the variable that needs to be updated, either "farmId", "name", or "acres" (character string) (required)

value_update

the new value for variable_update, to replace the existing value. The existing value can be found using get_fields("field_id") (character string) (required)

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

Fields are the easiest way to manage locations in the aWhere APIs, providing an easy reference for tracking weather, agronomics, models, and progress over growing seasons. Once a field is registered, plantings can also be registered for that field with specific information about the crop planted at that location, the date of planting, and other optional information.

Occasionally, you may need to update the details of your field. At this time, only the farm ID, field Name, and number of acres can be updated using this function. Field details can only be updated one variable at a time, for one field at a time. If you need to update multiple fields or multiple variables associated with a field, please pass commands sequentially.

Value

- A message confirming the changes have been made

References

https://docs.awhere.com/knowledge-base-docs/update-a-field-location/

Examples

1
## Not run: update_field(field_id = 'field_test',variable_update = 'farmId', value_update = 'This is my territory')

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