-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathcreate_field.Rd
More file actions
70 lines (59 loc) · 2.7 KB
/
Copy pathcreate_field.Rd
File metadata and controls
70 lines (59 loc) · 2.7 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/create.R
\name{create_field}
\alias{create_field}
\title{Create Field}
\usage{
create_field(
field_id,
latitude,
longitude,
farm_id,
field_name = "",
acres = "",
verbose = TRUE,
keyToUse = awhereEnv75247$uid,
secretToUse = awhereEnv75247$secret,
tokenToUse = awhereEnv75247$token,
apiAddressToUse = awhereEnv75247$apiAddress
)
}
\arguments{
\item{field_id}{an ID of your choosing (string)}
\item{latitude}{the latitude of the field location in decimal format (double)}
\item{longitude}{the longitude of the field location in decimal format (double)}
\item{field_name}{a name of the location (optional - string)}
\item{acres}{the acres of the field (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)}
\item{farmid}{an ID of your choosing for the farm to which this field belongs (string)}
}
\value{
- printed text that informs if the query succeeded or not
}
\description{
\code{create_field} This function will generate a new field associated with the user's account in the aWhere API.
This is a one-time operation for each field.
}
\details{
Fields are how you manage the locations for which you're tracking weather, agronomics,
models, and progress over growing seasons in the aWhere API. By registering a field, you create a quick way
to consistently reference locations across all of our APIs, and allow our modeling APIs
to better operate and tune to the conditions and status of each specific field.
Creating a field registers the location with the aWhere system, making it easier to reference
and track your locations as well as run agronomics and models automatically. You
only need to create a field once, after which you can reference the field by ID
(you'll use this ID in most URI endpoints in the aWhere system).
All spaces will be converted to underscores to conform with the requirements of the API.
}
\examples{
\dontrun{
create_field(field_id = "field123",latitude = 39.8282,longitude = -98.5795,farm_id = "farmA",field_name = "Some Field Location",acres = 100)
create_field(field_id = "field_test", latitude = 39.971906, longitude = -105.088773, farm_id = "Office")
}
}
\references{
https://docs.awhere.com/knowledge-base-docs/create-a-field-location/
}