From b2336175a354c5a6211b0db9102b4a6d3e6d7cf2 Mon Sep 17 00:00:00 2001
From: Laura DeCicco <ldecicco@usgs.gov>
Date: Wed, 9 Jul 2014 11:24:41 -0500
Subject: [PATCH] Improved help docs.
---
man/getDataAvailability.Rd | 10 ++++++----
man/padVariable.Rd | 2 ++
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/man/getDataAvailability.Rd b/man/getDataAvailability.Rd
index ba9b1331..4ed2e1e9 100644
--- a/man/getDataAvailability.Rd
+++ b/man/getDataAvailability.Rd
@@ -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}
diff --git a/man/padVariable.Rd b/man/padVariable.Rd
index a7a473b9..1613444d 100644
--- a/man/padVariable.Rd
+++ b/man/padVariable.Rd
@@ -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}
--
GitLab