get_models: Get Models

Description Usage Arguments Details Value References Examples

View source: R/models.R

Description

get_models Calls Models endpoint of API

Usage

1
2
3
4
5
6
7
get_models(
  model_id = "",
  keyToUse = awhereEnv75247$uid,
  secretToUse = awhereEnv75247$secret,
  tokenToUse = awhereEnv75247$token,
  apiAddressToUse = awhereEnv75247$apiAddress
)

Arguments

model_id

Either a model id to retrieve information for that specific model or an empty string to retrieve information on all model associated with the user's aWhere API account (string - optional)

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

This API provides the list of available models in the aWhere platform. Today a variety of crop growth stage models are generally available, with many more on the way.

Each models applies to particular crops from the Crops API, and after an initial review of the available models, you can often save the model ID and simply reference the details and results as needed.

Value

- data.frame containing information about requested model(s)

References

https://developer.awhere.com/api/reference/models/get-models

Examples

1
2
3
4
## Not run: get_models('BarleyGenericMSU')
         get_models()

## End(Not run)

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