From cbd30c7e91c51c3f7ec8915ce6c544d372d2bce6 Mon Sep 17 00:00:00 2001 From: unknown <ldecicco@usgs.gov> Date: Tue, 9 Sep 2014 10:31:09 -0500 Subject: [PATCH] Unifying argument names. --- R/retrieveUnitNWISData.r | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/R/retrieveUnitNWISData.r b/R/retrieveUnitNWISData.r index 1e2d5bd6..657ae6a3 100644 --- a/R/retrieveUnitNWISData.r +++ b/R/retrieveUnitNWISData.r @@ -5,9 +5,9 @@ #' A list of statistic codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} #' #' @param siteNumber string USGS site number. This is usually an 8 digit number -#' @param ParameterCd string USGS parameter code. This is usually an 5 digit number. -#' @param StartDate string starting date for data retrieval in the form YYYY-MM-DD. -#' @param EndDate string ending date for data retrieval in the form YYYY-MM-DD. +#' @param parameterCd string USGS parameter code. This is usually an 5 digit number. +#' @param startDate string starting date for data retrieval in the form YYYY-MM-DD. +#' @param endDate string ending date for data retrieval in the form YYYY-MM-DD. #' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. #' @param format string, can be "tsv" or "xml", and is only applicable for daily and unit value requests. "tsv" returns results faster, but there is a possiblitiy that an incomplete file is returned without warning. XML is slower, #' but will offer a warning if the file was incomplete (for example, if there was a momentary problem with the internet connection). It is possible to safely use the "tsv" option, @@ -17,15 +17,15 @@ #' @export #' @examples #' siteNumber <- '05114000' -#' ParameterCd <- '00060' -#' StartDate <- as.character(Sys.Date()) -#' EndDate <- as.character(Sys.Date()) +#' parameterCd <- '00060' +#' startDate <- as.character(Sys.Date()) +#' endDate <- as.character(Sys.Date()) #' # These examples require an internet connection to run -#' rawData <- retrieveNWISunitData(siteNumber,ParameterCd,StartDate,EndDate) -#' rawData2 <- retrieveNWISunitData(siteNumber,ParameterCd,StartDate,EndDate,"tsv") -retrieveNWISunitData <- function (siteNumber,ParameterCd,StartDate,EndDate,format="xml",interactive=TRUE){ +#' rawData <- retrieveNWISunitData(siteNumber,parameterCd,startDate,endDate) +#' rawData2 <- retrieveNWISunitData(siteNumber,parameterCd,startDate,endDate,"tsv") +retrieveNWISunitData <- function (siteNumber,parameterCd,startDate,endDate,format="xml",interactive=TRUE){ - url <- constructNWISURL(siteNumber,ParameterCd,StartDate,EndDate,"uv",format=format,interactive=interactive) + url <- constructNWISURL(siteNumber,parameterCd,startDate,endDate,"uv",format=format,interactive=interactive) if (format == "xml") { data <- getWaterML1Data(url) } else { -- GitLab