Skip to content
Snippets Groups Projects
Commit 216b183f authored by Laura A DeCicco's avatar Laura A DeCicco
Browse files

Unifying argument names.

parent a56a6443
No related branches found
No related tags found
1 merge request!7Response to reviewer's comments.
Showing
with 34 additions and 34 deletions
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{ChoptankRiverFlow}
\alias{ChoptankRiverFlow}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{data}
\name{ChoptankRiverNitrate}
\alias{ChoptankRiverNitrate}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{checkStartEndDate}
\alias{checkStartEndDate}
\title{checkStartEndDate}
\usage{
checkStartEndDate(StartDate, EndDate, interactive = TRUE)
checkStartEndDate(startDate, endDate, interactive = TRUE)
}
\arguments{
\item{StartDate}{string}
\item{startDate}{string}
\item{EndDate}{string}
\item{endDate}{string}
\item{interactive}{logical Option for interactive mode. If true, there is user interaction for error handling and data checks.}
}
\value{
vector where first value is StartDate, second is EndDate
vector where first value is startDate, second is endDate
}
\description{
Checks that the start date is before the end date. If not, it will give the user the opportunity to correct, otherwise will create a warning.
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{compressData}
\alias{compressData}
\title{Compress sample data frame}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{constructNWISURL}
\alias{constructNWISURL}
\title{Construct NWIS url for data retrieval}
......@@ -16,10 +16,10 @@ constructNWISURL(siteNumber, parameterCd, startDate, endDate, service,
\item{endDate}{string ending date for data retrieval in the form YYYY-MM-DD.}
\item{statCd}{string or vector USGS statistic code only used for daily value service. This is usually 5 digits. Daily mean (00003) is the default.}
\item{service}{string USGS service to call. Possible values are "dv" (daily values), "uv" (unit/instantaneous values), "qw" (water quality data), and "wqp" (water quality portal, which can include STORET).}
\item{statCd}{string or vector USGS statistic code only used for daily value service. This is usually 5 digits. Daily mean (00003) is the default.}
\item{format}{string, can be "tsv" or "xml", and is only applicable for daily and unit value requests. "tsv" returns results faster, but there is a possiblitiy that an incomplete file is returned without warning. XML is slower,
but will offer a warning if the file was incomplete (for example, if there was a momentary problem with the internet connection). It is possible to safely use the "tsv" option,
but the user must carefully check the results to see if the data returns matches what is expected. The default is therefore "xml".}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{dataOverview}
\alias{dataOverview}
\title{Data Overview for WRTDS}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{package}
\name{dataRetrieval-package}
\alias{dataRetrieval-package}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{dateFormatCheck}
\alias{dateFormatCheck}
\title{Check date format}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{formatCheckDate}
\alias{formatCheckDate}
\title{formatCheckDate}
......@@ -20,7 +20,7 @@ Response to the date format checker. If the date is not formated correctly, it
}
\examples{
Date <- '1985-01-01'
dateString <- 'StartDate'
dateString <- 'startDate'
formatCheckDate(Date, dateString, interactive = FALSE)
}
\keyword{WRTDS}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{formatCheckParameterCd}
\alias{formatCheckParameterCd}
\title{formatCheckParameterCd}
\usage{
formatCheckParameterCd(ParameterCd, interactive = TRUE)
formatCheckParameterCd(parameterCd, interactive = TRUE)
}
\arguments{
\item{ParameterCd}{string to check}
\item{parameterCd}{string to check}
\item{interactive}{logical Option for interactive mode. If true, there is user interaction for error handling and data checks.}
}
\value{
ParameterCd string
parameterCd string
}
\description{
Checks that the parameter code is 5 digits. If it is less, it will pad the string with zeros. If more, ask the user to re-enter.
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{formatCheckSiteNumber}
\alias{formatCheckSiteNumber}
\title{formatCheckSiteNumber}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getDVData}
\alias{getDVData}
\title{Import Daily Data for WRTDS}
\usage{
getDVData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE,
getDVData(siteNumber, parameterCd, startDate, endDate, interactive = TRUE,
convert = TRUE, format = "tsv")
}
\arguments{
\item{siteNumber}{string USGS site number. This is usually an 8 digit number}
\item{ParameterCd}{string USGS parameter code. This is usually an 5 digit number.}
\item{parameterCd}{string USGS parameter code. This is usually an 5 digit number.}
\item{StartDate}{string starting date for data retrieval in the form YYYY-MM-DD.}
\item{startDate}{string starting date for data retrieval in the form YYYY-MM-DD.}
\item{EndDate}{string ending date for data retrieval in the form YYYY-MM-DD.}
\item{endDate}{string ending date for data retrieval in the form YYYY-MM-DD.}
\item{interactive}{logical Option for interactive mode. If true, there is user interaction for error handling and data checks.}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getDailyDataFromFile}
\alias{getDailyDataFromFile}
\title{Import Daily Data for WRTDS}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getDataAvailability}
\alias{getDataAvailability}
\title{USGS data availability}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getDataFromFile}
\alias{getDataFromFile}
\title{Basic Data Import for Water Flow Data}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getGeneralWQPData}
\alias{getGeneralWQPData}
\title{General Data Import from Water Quality Portal}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getMetaData}
\alias{getMetaData}
\title{Import Metadata for USGS Data}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getNWISSites}
\alias{getNWISSites}
\title{Site Data Import from NWIS}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getParameterInfo}
\alias{getParameterInfo}
\title{USGS Parameter Data Retrieval}
......
% Generated by roxygen2 (4.0.1): do not edit by hand
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{getQWDataFromFile}
\alias{getQWDataFromFile}
\title{Basic Data Import}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment