wqpSpecials.Rd 7.29 KB
Newer Older
Laura A DeCicco's avatar
Laura A DeCicco committed
1
% Generated by roxygen2: do not edit by hand
2
3
4
5
% Please edit documentation in R/whatWQPdata.R, R/whatWQPsites.R
\name{whatWQPsamples}
\alias{whatWQPsamples}
\alias{whatWQPmetrics}
Laura A DeCicco's avatar
Laura A DeCicco committed
6
\alias{whatWQPsites}
7
\alias{readWQPsummary}
Laura A DeCicco's avatar
Laura A DeCicco committed
8
\title{Site Data Import from Water Quality Portal}
Laura A DeCicco's avatar
Laura A DeCicco committed
9
\usage{
10
11
12
13
whatWQPsamples(...)

whatWQPmetrics(...)

Laura A DeCicco's avatar
Laura A DeCicco committed
14
whatWQPsites(...)
15

16
readWQPsummary(...)
Laura A DeCicco's avatar
Laura A DeCicco committed
17
18
}
\arguments{
Laura A DeCicco's avatar
Laura A DeCicco committed
19
\item{\dots}{see \url{https://www.waterqualitydata.us/webservices_documentation} for a complete list of options. A list of arguments can also be supplied.}
Laura A DeCicco's avatar
Laura A DeCicco committed
20
21
}
\value{
22
A data frame with at least the following columns:
Laura A DeCicco's avatar
Laura A DeCicco committed
23
\tabular{lll}{ 
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
Name \tab Type \tab Description \cr
OrganizationIdentifier \tab character \tab  A designator used to uniquely identify a unique business establishment within a context. \cr
OrganizationFormalName \tab character \tab	The legal designator (i.e. formal name) of an organization. \cr
MonitoringLocationIdentifier \tab character \tab	A designator used to describe the unique name, number, or code assigned to identify the monitoring location. \cr
MonitoringLocationName \tab character \tab	The designator specified by the sampling organization for the site at which sampling or other activities are conducted. \cr
MonitoringLocationTypeName \tab character \tab	The descriptive name for a type of monitoring location. \cr
MonitoringLocationDescriptionText \tab character \tab 	Text description of the monitoring location. \cr
HUCEightDigitCode \tab character \tab	The 8 digit federal code used to identify the hydrologic unit of the monitoring location to the cataloging unit level of precision. \cr
DrainageAreaMeasure/MeasureValue * \tab character \tab	The drainage basin of a lake, stream, wetland, or estuary site. Measure value is given in the units stored in DrainageAreaMeasure/MeasureUnitCode. \cr
DrainageAreaMeasure/MeasureUnitCode * \tab character \tab	The code that represents the unit for measuring the item. \cr
ContributingDrainageAreaMeasure/MeasureValue * \tab character \tab	The contributing drainage area of a lake, stream, wetland, or estuary site. Measure value is given in the units stored in ContributingDrainageAreaMeasure/MeasureUnitCode. \cr
ContributingDrainageAreaMeasure/MeasureUnitCode * \tab character \tab	The code that represents the unit for measuring the item. \cr
LatitudeMeasure \tab numeric \tab	The measure of the angular distance on a meridian north or south of the equator. \cr
LongitudeMeasure \tab numeric \tab	The measure of the angular distance on a meridian east or west of the prime meridian. \cr
SourceMapScaleNumeric \tab character \tab	The number that represents the proportional distance on the ground for one unit of measure on the map or photo. \cr
HorizontalAccuracyMeasure/MeasureValue * \tab character \tab	The horizontal measure of the relative accuracy of the latitude and longitude coordinates." Measure value is given in the units stored in HorizontalAccuracyMeasure/MeasureUnitCode. \cr
HorizontalAccuracyMeasure/MeasureUnitCode * \tab character \tab	The code that represents the unit for measuring the item. \cr
HorizontalCollectionMethodName \tab character \tab	The name that identifies the method used to determine the latitude and longitude coordinates for a point on the earth. \cr
HorizontalCoordinateReferenceSystemDatumName \tab character \tab	The name that describes the reference datum used in determining latitude and longitude coordinates. \cr
VerticalMeasure/MeasureValue \tab character \tab	The measure of elevation (i.e., the altitude), above or below a reference datum. Measure value is given in the units stored in VerticalMeasure/MeasureUnitCode. \cr
VerticalMeasure/MeasureUnitCode \tab character \tab	The code that represents the unit for measuring the item. \cr
VerticalAccuracyMeasure/MeasureValue * \tab character \tab	The vertical measure of the relative accuracy of the latitude and longitude coordinates. Measure value is given in the units stored in VerticalAccuracyMeasure/MeasureUnitCode. \cr
VerticalAccuracyMeasure/MeasureUnitCode * \tab character \tab	The code that represents the unit for measuring the item. \cr
VerticalCollectionMethodName \tab character \tab	The name that identifies the method used to collect the vertical measure (i.e. the altitude) of a reference point. \cr
VerticalCoordinateReferenceSystemDatumName \tab character \tab	The name of the reference datum used to determine the vertical measure (i.e., the altitude). \cr
CountryCode \tab character \tab	A code designator used to identify a primary geopolitical unit of the world. \cr
StateCode \tab character \tab	A code designator used to identify a principal administrative subdivision of the United States, Canada, or Mexico. \cr
CountyCode \tab character \tab	A code designator used to identify a U.S. county or county equivalent. \cr
AquiferName * \tab character \tab 	Name of the aquifer in which the well is completed. \cr
FormationTypeText * \tab character \tab	Name of the primary formation or soils unit, in which the well is completed. \cr
AquiferTypeName * \tab character \tab	The type of aquifer, such as confined or unconfined. \cr
ConstructionDateText * \tab character \tab	Date of construction when well was completed. May be year only. \cr
WellDepthMeasure/MeasureValue * \tab character \tab	Depth below land surface datum (LSD) to the bottom of the hole on completion of drilling. Measure value is given in the units stored in WellDepthMeasure/MeasureUnitCode. \cr
WellDepthMeasure/MeasureUnitCode * \tab character \tab	The code that represents the unit for measuring the item. \cr
WellHoleDepthMeasure/MeasureValue * \tab character \tab	Depth below land surface datum (LSD) to the bottom of the hole on completion of drilling. Measure value is given in the units stored in WellHoleDepthMeasure/MeasureUnitCode. \cr
WellHoleDepthMeasure/MeasureUnitCode * \tab character \tab	The code that represents the unit for measuring the item. \cr
queryTime \tab POSIXct \tab Query time \cr
}
* element is only in NWIS
Laura A DeCicco's avatar
Laura A DeCicco committed
63
64
}
\description{
Laura A DeCicco's avatar
Laura A DeCicco committed
65
Returns a list of sites from the Water Quality Portal web service. This function gets the data from: \url{https://www.waterqualitydata.us}.
Laura A DeCicco's avatar
Laura A DeCicco committed
66
67
68
69
Arguments to the function should be based on \url{https://www.waterqualitydata.us/webservices_documentation}. The return from 
this function returns the basic metadata on WQP sites. It is
generally faster than the \code{\link{whatWQPdata}} function, but does
not return information on what data was collected at the site.
Laura A DeCicco's avatar
Laura A DeCicco committed
70
}
71
72
73
\details{
The \code{readWQPsummary} function has
}
Laura A DeCicco's avatar
Laura A DeCicco committed
74
\examples{
75
\donttest{
Laura A DeCicco's avatar
Laura A DeCicco committed
76
try({
77
78
79
80
site1 <- whatWQPsamples(siteid="USGS-01594440")

type <- "Stream"
sites <- whatWQPsamples(countycode="US:55:025",siteType=type)
Laura A DeCicco's avatar
Laura A DeCicco committed
81
})
82
83
84
85
86
87
88
89
}
\donttest{

type <- "Stream"
sites <- whatWQPmetrics(countycode="US:55:025",siteType=type)
lakeSites <- whatWQPmetrics(siteType = "Lake, Reservoir, Impoundment", statecode = "US:55")
}
\donttest{
Laura A DeCicco's avatar
Laura A DeCicco committed
90
try({
Laura A DeCicco's avatar
Laura A DeCicco committed
91
92
site1 <- whatWQPsites(siteid="USGS-01594440")

Laura A DeCicco's avatar
Laura A DeCicco committed
93
type <- "Stream"
94
95
96
sites <- whatWQPsites(countycode="US:55:025",
                      characteristicName = "Phosphorus",
                      siteType=type)
Laura A DeCicco's avatar
Laura A DeCicco committed
97
})
Laura A DeCicco's avatar
Laura A DeCicco committed
98
}
99
\donttest{
100
site1 <- readWQPsummary(siteid="USGS-07144100",
101
102
103
                        summaryYears=5,
                        dataProfile="periodOfRecord")
# Pretty slow:
104
#state1 <- readWQPsummary(statecode="NJ",
105
106
#                          dataProfile="periodOfRecord")
}
Laura A DeCicco's avatar
Laura A DeCicco committed
107
}
Laura A DeCicco's avatar
Laura A DeCicco committed
108
109
110
\seealso{
whatNWISdata
}
Laura A DeCicco's avatar
Laura A DeCicco committed
111
112
113
114
115
\keyword{WQP}
\keyword{data}
\keyword{import}
\keyword{service}
\keyword{web}