update_planting: Update Planting

Description Usage Arguments Details Value References Examples

View source: R/update.R

Description

update_planting To update details of a particular planting

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
update_planting(
  field_id,
  planting_id,
  planting_date = "",
  proj_yield_amount = "",
  proj_yield_units = "",
  proj_harvest_date = "",
  yield_amount = "",
  yield_units = "",
  harvest_date = "",
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

Arguments

field_id

ID of field to search for plantings within

planting_id

ID of planting to update

planting_date

new date to update as planting's plant date

proj_yield_amount

new amount to update as planting's projected yield amount

proj_yield_units

new units to update as planting's projected yield units

proj_harvest_date

new projected harvest date to update as planting's projected harvest date

yield_amount

new amount to update as planting's yield amount

yield_units

new units to update as planting's yield units

harvest_date

new actual harvest date to update as planting's harvest date

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

Occasionally you will need to update a planting, changing the projections or recording the end-of-season information for historical tracking and model tuning. This API supports both partial and complete updates of plantings. When updating an entire planting, the whole object is replaced in the database. Any properties that were previously set, and now are not, will be null'd. The required properties must also be set even if they are changed.

Value

- A message confirming the changes have been made

References

https://docs.awhere.com/knowledge-base-docs/update-all-or-part-of-a-planting-in-a-field/

Examples

1
## Not run: update_planting("field_test", "156036", harvest_date = "2016-02-01", yield_amount = "60", yield_units = "Bushels")

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