Commit 1fa2e431 authored by Laura A DeCicco's avatar Laura A DeCicco
Browse files

Roxygen update

parent 09c1e8c9
......@@ -47,4 +47,4 @@ BuildVignettes: true
VignetteBuilder: knitr
BugReports: https://github.com/USGS-R/dataRetrieval/issues
URL: https://pubs.usgs.gov/tm/04/a10/
RoxygenNote: 6.1.1
RoxygenNote: 7.0.2
License
=======
Unless otherwise noted, This project is in the public domain in the United
States because it contains materials that originally came from the United
States Geological Survey, an agency of the United States Department of
Interior. For more information, see the official USGS copyright policy at
https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits
Additionally, we waive copyright and related rights in the work
worldwide through the CC0 1.0 Universal public domain dedication.
CC0 1.0 Universal Summary
-------------------------
This is a human-readable summary of the
[Legal Code (read the full text)][1].
### No Copyright
The person who associated a work with this deed has dedicated the work to
the public domain by waiving all of his or her rights to the work worldwide
under copyright law, including all related and neighboring rights, to the
extent allowed by law.
You can copy, modify, distribute and perform the work, even for commercial
purposes, all without asking permission.
### Other Information
In no way are the patent or trademark rights of any person affected by CC0,
nor are the rights that other persons may have in the work or in how the
work is used, such as publicity or privacy rights.
Unless expressly stated otherwise, the person who associated a work with
this deed makes no warranties about the work, and disclaims liability for
all uses of the work, to the fullest extent permitted by applicable law.
When using or citing the work, you should not imply endorsement by the
author or the affirmer.
[1]: https://creativecommons.org/publicdomain/zero/1.0/legalcode
......@@ -4,10 +4,19 @@
\alias{constructNWISURL}
\title{Construct NWIS url for data retrieval}
\usage{
constructNWISURL(siteNumbers, parameterCd = "00060", startDate = "",
endDate = "", service, statCd = "00003", format = "xml",
expanded = TRUE, ratingType = "base", statReportType = "daily",
statType = "mean")
constructNWISURL(
siteNumbers,
parameterCd = "00060",
startDate = "",
endDate = "",
service,
statCd = "00003",
format = "xml",
expanded = TRUE,
ratingType = "base",
statReportType = "daily",
statType = "mean"
)
}
\arguments{
\item{siteNumbers}{string or vector of strings USGS site number. This is usually an 8 digit number}
......
......@@ -3,7 +3,6 @@
\docType{package}
\name{dataRetrieval}
\alias{dataRetrieval}
\alias{dataRetrieval-package}
\title{Retrieval functions for USGS and EPA data}
\description{
\tabular{ll}{
......@@ -19,7 +18,7 @@ LazyLoad: \tab yes\cr
}
}
\details{
Retrieval functions for USGS and EPA hydrologic and water quality data.
Retrieval functions for USGS and EPA hydrologic and water quality data.
Please see \url{https://pubs.er.usgs.gov/publication/tm4A10} for more information.
}
......
......@@ -4,8 +4,7 @@
\alias{importRDB1}
\title{Function to return data from the NWIS RDB 1.0 format}
\usage{
importRDB1(obs_url, asDateTime = TRUE, convertType = TRUE,
tz = "UTC")
importRDB1(obs_url, asDateTime = TRUE, convertType = TRUE, tz = "UTC")
}
\arguments{
\item{obs_url}{character containing the url for the retrieval or a file path to the data file.}
......
......@@ -4,8 +4,13 @@
\alias{readNWISdv}
\title{Daily Value USGS NWIS Data Retrieval}
\usage{
readNWISdv(siteNumbers, parameterCd, startDate = "", endDate = "",
statCd = "00003")
readNWISdv(
siteNumbers,
parameterCd,
startDate = "",
endDate = "",
statCd = "00003"
)
}
\arguments{
\item{siteNumbers}{character USGS site number. This is usually an 8 digit number. Multiple sites can be requested with a character vector.}
......
......@@ -4,8 +4,13 @@
\alias{readNWISgwl}
\title{Groundwater level measurements retrieval from USGS (NWIS)}
\usage{
readNWISgwl(siteNumbers, startDate = "", endDate = "",
convertType = TRUE, tz = "UTC")
readNWISgwl(
siteNumbers,
startDate = "",
endDate = "",
convertType = TRUE,
tz = "UTC"
)
}
\arguments{
\item{siteNumbers}{character USGS site number (or multiple sites). This is usually an 8 digit number}
......
......@@ -4,8 +4,14 @@
\alias{readNWISmeas}
\title{Surface-water measurement data retrieval from USGS (NWIS)}
\usage{
readNWISmeas(siteNumbers, startDate = "", endDate = "", tz = "UTC",
expanded = FALSE, convertType = TRUE)
readNWISmeas(
siteNumbers,
startDate = "",
endDate = "",
tz = "UTC",
expanded = FALSE,
convertType = TRUE
)
}
\arguments{
\item{siteNumbers}{character USGS site number (or multiple sites). This is usually an 8 digit number}
......
......@@ -4,8 +4,13 @@
\alias{readNWISpeak}
\title{Peak flow data from USGS (NWIS)}
\usage{
readNWISpeak(siteNumbers, startDate = "", endDate = "",
asDateTime = TRUE, convertType = TRUE)
readNWISpeak(
siteNumbers,
startDate = "",
endDate = "",
asDateTime = TRUE,
convertType = TRUE
)
}
\arguments{
\item{siteNumbers}{character USGS site number(or multiple sites). This is usually an 8 digit number.}
......
......@@ -4,8 +4,15 @@
\alias{readNWISqw}
\title{Raw Data Import for USGS NWIS QW Data}
\usage{
readNWISqw(siteNumbers, parameterCd, startDate = "", endDate = "",
expanded = TRUE, reshape = FALSE, tz = "UTC")
readNWISqw(
siteNumbers,
parameterCd,
startDate = "",
endDate = "",
expanded = TRUE,
reshape = FALSE,
tz = "UTC"
)
}
\arguments{
\item{siteNumbers}{character of USGS site numbers. This is usually an 8 digit number}
......
......@@ -4,8 +4,15 @@
\alias{readNWISstat}
\title{Site statistics retrieval from USGS (NWIS)}
\usage{
readNWISstat(siteNumbers, parameterCd, startDate = "", endDate = "",
convertType = TRUE, statReportType = "daily", statType = "mean")
readNWISstat(
siteNumbers,
parameterCd,
startDate = "",
endDate = "",
convertType = TRUE,
statReportType = "daily",
statType = "mean"
)
}
\arguments{
\item{siteNumbers}{character USGS site number (or multiple sites). This is usually an 8 digit number.}
......
......@@ -4,8 +4,14 @@
\alias{readNWISuse}
\title{Water use data retrieval from USGS (NWIS)}
\usage{
readNWISuse(stateCd, countyCd, years = "ALL", categories = "ALL",
convertType = TRUE, transform = FALSE)
readNWISuse(
stateCd,
countyCd,
years = "ALL",
categories = "ALL",
convertType = TRUE,
transform = FALSE
)
}
\arguments{
\item{stateCd}{could be character (full name, abbreviation, id), or numeric (id). Only one is accepted per query.}
......
......@@ -4,8 +4,7 @@
\alias{readNWISuv}
\title{Instantaneous value data retrieval from USGS (NWIS)}
\usage{
readNWISuv(siteNumbers, parameterCd, startDate = "", endDate = "",
tz = "UTC")
readNWISuv(siteNumbers, parameterCd, startDate = "", endDate = "", tz = "UTC")
}
\arguments{
\item{siteNumbers}{character USGS site number (or multiple sites). This is usually an 8 digit number}
......
......@@ -4,8 +4,14 @@
\alias{readWQPqw}
\title{Raw Data Import for Water Quality Portal}
\usage{
readWQPqw(siteNumbers, parameterCd, startDate = "", endDate = "",
tz = "UTC", querySummary = FALSE)
readWQPqw(
siteNumbers,
parameterCd,
startDate = "",
endDate = "",
tz = "UTC",
querySummary = FALSE
)
}
\arguments{
\item{siteNumbers}{character site number. This needs to include the full agency code prefix.}
......
......@@ -4,10 +4,20 @@
\alias{renameNWISColumns}
\title{renameColumns}
\usage{
renameNWISColumns(rawData, p00010 = "Wtemp", p00045 = "Precip",
p00060 = "Flow", p00065 = "GH", p00095 = "SpecCond",
p00300 = "DO", p00400 = "pH", p62611 = "GWL", p63680 = "Turb",
p72019 = "WLBLS", ...)
renameNWISColumns(
rawData,
p00010 = "Wtemp",
p00045 = "Precip",
p00060 = "Flow",
p00065 = "GH",
p00095 = "SpecCond",
p00300 = "DO",
p00400 = "pH",
p62611 = "GWL",
p63680 = "Turb",
p72019 = "WLBLS",
...
)
}
\arguments{
\item{rawData}{the daily- or unit-values datset retrieved from NWISweb.}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment