From 98e9b1df9d058a785d426a0e6a6bd8c12898a99b Mon Sep 17 00:00:00 2001
From: Laura DeCicco <ldecicco@usgs.gov>
Date: Wed, 20 Nov 2013 14:49:46 -0600
Subject: [PATCH] Added details on multiple constituents.
---
R/getSampleDataFromFile.r | 3 ++-
man/getSampleDataFromFile.Rd | 5 +++--
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/R/getSampleDataFromFile.r b/R/getSampleDataFromFile.r
index 9cb560a1..34f81f98 100644
--- a/R/getSampleDataFromFile.r
+++ b/R/getSampleDataFromFile.r
@@ -1,6 +1,7 @@
#' Import Sample Data for WRTDS
#'
-#' Imports data from a user-supplied file, and converts it to a Sample data frame, appropriate for WRTDS calculations.
+#' Imports data from a user-supplied file, and converts it to a Sample data frame (including summing multiple constituents), appropriate for WRTDS calculations. See
+#' section 3.4 of the vignette for more details.
#'
#' @param filePath string specifying the path to the file
#' @param fileName string name of file to open
diff --git a/man/getSampleDataFromFile.Rd b/man/getSampleDataFromFile.Rd
index 41907f99..9ab9723c 100644
--- a/man/getSampleDataFromFile.Rd
+++ b/man/getSampleDataFromFile.Rd
@@ -25,8 +25,9 @@
}
\description{
Imports data from a user-supplied file, and converts it
- to a Sample data frame, appropriate for WRTDS
- calculations.
+ to a Sample data frame (including summing multiple
+ constituents), appropriate for WRTDS calculations. See
+ section 3.4 of the vignette for more details.
}
\examples{
# Examples of how to use getSampleDataFromFile:
--
GitLab