-
Notifications
You must be signed in to change notification settings - Fork 19
/
get_SDA_coecoclass.Rd
56 lines (44 loc) · 2.83 KB
/
get_SDA_coecoclass.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get_SDA_coecoclass.R
\name{get_SDA_coecoclass}
\alias{get_SDA_coecoclass}
\title{Get mapunit ecological sites from Soil Data Access}
\usage{
get_SDA_coecoclass(
method = "None",
areasymbols = NULL,
mukeys = NULL,
WHERE = NULL,
query_string = FALSE,
ecoclasstypename = c("NRCS Rangeland Site", "NRCS Forestland Site"),
ecoclassref = "Ecological Site Description Database",
not_rated_value = "Not assigned",
miscellaneous_areas = TRUE,
include_minors = TRUE,
threshold = 0,
dsn = NULL
)
}
\arguments{
\item{method}{aggregation method. One of: \code{"Dominant Component"}, \code{"Dominant Condition"}, \code{"All"} or \code{"None"} (default). If \code{method="all"} multiple numbered columns represent site composition within each map unit e.g. \code{site1...}, \code{site2...}. If \code{method="none"} is selected one row will be returned per \emph{component}; in all other cases one row will be returned per \emph{map unit}.}
\item{areasymbols}{vector of soil survey area symbols}
\item{mukeys}{vector of map unit keys}
\item{WHERE}{character containing SQL WHERE clause specified in terms of fields in \code{legend}, \code{mapunit}, \code{component} or \code{coecosite} tables, used in lieu of \code{mukeys} or \code{areasymbols}}
\item{query_string}{Default: \code{FALSE}; if \code{TRUE} return a character string containing query that would be sent to SDA via \code{SDA_query}}
\item{ecoclasstypename}{Default: \code{c("NRCS Rangeland Site", "NRCS Forestland Site")}. If \code{NULL} no constraint on \code{ecoclasstypename} is used in the query.}
\item{ecoclassref}{Default: \code{"Ecological Site Description Database"}. If \code{NULL} no constraint on \code{ecoclassref} is used in the query.}
\item{not_rated_value}{Default: \code{"Not assigned"}}
\item{miscellaneous_areas}{logical. Include miscellaneous areas (non-soil components)?}
\item{include_minors}{logical. Include minor components? Default: \code{TRUE}.}
\item{threshold}{integer. Default: \code{0}. Minimum combined component percentage (RV) for inclusion of a mapunit's ecological site in wide-format tabular summary. Used only for \code{method="all"}.}
\item{dsn}{Path to local SQLite database or a DBIConnection object. If \code{NULL} (default) use Soil Data Access API via \code{SDA_query()}.}
}
\description{
Get mapunit ecological sites from Soil Data Access
}
\details{
When \code{method="Dominant Condition"} an additional field \code{ecoclasspct_r} is returned in the result
with the sum of \code{comppct_r} that have the dominant condition \code{ecoclassid}. The component with the greatest
\code{comppct_r} is returned for the \code{component} and \code{coecosite} level information.
Note that if there are multiple \code{coecoclasskey} per \code{ecoclassid} there may be more than one record per component.
}