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

Improved help docs.

parent 93129a00
No related branches found
No related tags found
No related merge requests found
......@@ -3,22 +3,24 @@
\alias{getDataAvailability}
\title{USGS data availability}
\usage{
getDataAvailability(siteNumber, interactive = TRUE)
getDataAvailability(siteNumber, type = c("uv", "dv", "qw"))
}
\arguments{
\item{siteNumber}{string USGS site number. This is usually an 8 digit number}
\item{siteNumber}{string USGS site number.}
\item{interactive}{logical Option for interactive mode. If true, a progress indicator is printed to the console.}
\item{type}{vector string. Options are "uv", "dv", "qw"}
}
\value{
retval dataframe with all information found in the expanded site file
}
\description{
Imports a table of available parameters, period of record, and count. There is also an option to load the long parameter names and additional information on the parameters with longNames=TRUE.
Imports a table of available parameters, period of record, and count.
}
\examples{
# These examples require an internet connection to run
availableData <- getDataAvailability('05114000')
# To find just unit value ('instantaneous') data:
uvData <- availableData <- getDataAvailability('05114000',type="uv")
}
\keyword{USGS}
\keyword{data}
......
......@@ -19,6 +19,8 @@ Function to pad a string with leading zeros. Useful for parameter codes and USGS
\examples{
pCode <- '10'
correctPCode <- padVariable(pCode,5)
pCodes <- c('100','1000','0','12345','1565465465465465')
correctPCodes <- padVariable(pCodes,5)
}
\keyword{USGS}
\keyword{data}
......
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