-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathget_models.Rd
More file actions
48 lines (43 loc) · 1.71 KB
/
Copy pathget_models.Rd
File metadata and controls
48 lines (43 loc) · 1.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/models.R
\name{get_models}
\alias{get_models}
\title{Get Models}
\usage{
get_models(
model_id = "",
keyToUse = awhereEnv75247$uid,
secretToUse = awhereEnv75247$secret,
tokenToUse = awhereEnv75247$token,
apiAddressToUse = awhereEnv75247$apiAddress
)
}
\arguments{
\item{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)}
\item{keyToUse}{aWhere API key to use. For advanced use only. Most users will not need to use this parameter (optional)}
\item{secretToUse}{aWhere API secret to use. For advanced use only. Most users will not need to use this parameter (optional)}
\item{tokenToUse}{aWhere API token to use. For advanced use only. Most users will not need to use this parameter (optional)}
\item{apiAddressToUse}{Address of aWhere API to use. For advanced use only. Most users will not need to use this parameter (optional)}
}
\value{
- data.frame containing information about requested model(s)
}
\description{
\code{get_models} Calls Models endpoint of API
}
\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.
}
\examples{
\dontrun{get_models('BarleyGenericMSU')
get_models()
}
}
\references{
https://developer.awhere.com/api/reference/models/get-models
}