diff --git a/R/getSampleDataFromFile.r b/R/getSampleDataFromFile.r index 9cb560a10e987e6b0e017913ca288448cf1e4cd6..34f81f986130e09edfaf15975dde66753a4dee77 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 41907f997828a77f8393939512736290ebaf77f7..9ab9723ca0fc1518b3bd5d724b7adcf6a7861a01 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: