Merge pull request #96 from ldecicco-USGS/master

Fixes #95
DOI-USGS · Mar 6, 2015 · d3aef09 · d3aef09
2 parents 2f94143 + 3d3a079
commit d3aef09
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/R/readNWISqw.r b/R/readNWISqw.r
@@ -38,8 +38,9 @@
 #' dqi_cd (data-quality indicator code), rpt_lev_va (reporting level), and rpt_lev_cd (reporting level type). If \code{FALSE},
 #' only returns remark_cd (remark code) and result_va (result value). Expanded = \code{FALSE} will not give
 #' sufficient information for unbiased statistical analysis.
-#' @param reshape logical, reshape the data. If \code{TRUE}, then return a wide data frame with all water-quality in a single row for each sample. 
-#' If \code{FALSE} (default), then return a long data frame with each water-quality result in a single row.
+#' @param reshape logical, reshape the expanded data. If \code{TRUE}, then return a wide data frame with all water-quality in a single row for each sample. 
+#' If \code{FALSE} (default), then return a long data frame with each water-quality result in a single row. This
+#' argument is only applicable to expanded data. Data requested using \code{expanded=FALSE} is always returned in the wide format.
 #' @param tz character to set timezone attribute of datetime. Default is an empty quote, which converts the 
 #' datetimes to UTC (properly accounting for daylight savings times based on the data's provided tz_cd column).
 #' Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",

diff --git a/man/readNWISqw.Rd b/man/readNWISqw.Rd
@@ -25,8 +25,9 @@ dqi_cd (data-quality indicator code), rpt_lev_va (reporting level), and rpt_lev_
 only returns remark_cd (remark code) and result_va (result value). Expanded = \code{FALSE} will not give
 sufficient information for unbiased statistical analysis.}
 
-\item{reshape}{logical, reshape the data. If \code{TRUE}, then return a wide data frame with all water-quality in a single row for each sample.
-If \code{FALSE} (default), then return a long data frame with each water-quality result in a single row.}
+\item{reshape}{logical, reshape the expanded data. If \code{TRUE}, then return a wide data frame with all water-quality in a single row for each sample.
+If \code{FALSE} (default), then return a long data frame with each water-quality result in a single row. This
+argument is only applicable to expanded data. Data requested using \code{expanded=FALSE} is always returned in the wide format.}
 
 \item{tz}{character to set timezone attribute of datetime. Default is an empty quote, which converts the
 datetimes to UTC (properly accounting for daylight savings times based on the data's provided tz_cd column).