diff --git a/NAMESPACE b/NAMESPACE index 97289b5ca69cc86582b6d66cde8ef65216357459..b6f6c4555f053774fac3f7eab3cabb0ee0f65f8e 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,10 +1,5 @@ -export(checkStartEndDate) export(compressData) export(dataOverview) -export(dateFormatCheck) -export(formatCheckDate) -export(formatCheckParameterCd) -export(formatCheckSiteNumber) export(getDVData) export(getDailyDataFromFile) export(getDataFromFile) @@ -30,5 +25,11 @@ export(populateSiteINFO) export(removeDuplicates) export(retrieveNWISData) export(retrieveUnitNWISData) +export(formatCheckDate) +export(checkStartEndDate) +export(dateFormatCheck) +export(formatCheckParameterCd) +export(formatCheckSiteNumber) +exportClasses(fluxUnit) exportClasses(fluxUnit) import(zoo) diff --git a/R/checkStartEndDate.r b/R/checkStartEndDate.r index 0e6da15516e3ab379389539bb9a82c5c6d6ebeb9..b530915385b1c9bddec4c660f44964f120e3eacb 100644 --- a/R/checkStartEndDate.r +++ b/R/checkStartEndDate.r @@ -1,15 +1,3 @@ -#' Check Start End Dates -#' -#' Checks that the user-supplied starting date is before the ending date. If not, either the user can re-enter, or the dates will be set to maximum. -#' -#' @param StartDate string date -#' @param EndDate string date -#' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. -#' @keywords data import from web service -#' @return list StartDate,EndDate -#' @export -#' @examples -#' checkStartEndDate('1985-01-01', '1985-12-31') checkStartEndDate <- function(StartDate, EndDate,interactive=TRUE){ start <- as.Date("1850-01-01") end <- as.Date(Sys.Date()) diff --git a/R/dateFormatCheck.r b/R/dateFormatCheck.r index d54a9403594ad7b444b5f7efb7bc803ccd7967fb..6e47722aba1f64eb5d848d32e862fa36961f8113 100644 --- a/R/dateFormatCheck.r +++ b/R/dateFormatCheck.r @@ -1,14 +1,3 @@ -#' Date Formatting Check -#' -#' Checks that the user-supplied date is in the format YYYY-MM-DD and month is less than 13, and dates are less than 32. -#' -#' @param date string date to check -#' @keywords data import from web service -#' @return Date logical -#' @export -#' @examples -#' dateFormatCheck('1985-01-01') -#' dateFormatCheck('01/01/1985') dateFormatCheck <- function(date){ # checks for the format YYYY-MM-DD parts <- strsplit(date,"-",fixed=TRUE) condition <- FALSE diff --git a/R/formatCheckDate.r b/R/formatCheckDate.r index b2f0601642846ec81ffccf3e81f41ef9ee2b39e9..4f2a703c469b22533249a4da0cadf6a61dd5435b 100644 --- a/R/formatCheckDate.r +++ b/R/formatCheckDate.r @@ -1,15 +1,3 @@ -#' Date Formatting Correction -#' -#' Checks that the user-supplied date is in the format YYYY-MM-DD. If not, asks the user to re-enter. -#' -#' @param Date string date to check -#' @param dateString string should be either 'StartDate' or 'EndDate' -#' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. -#' @keywords data import from web service -#' @return Date string -#' @export -#' @examples -#' formatCheckDate('1985-01-01', 'StartDate') formatCheckDate <- function(Date, dateString,interactive=TRUE){ if(nzchar(Date)){ if (!dateFormatCheck(Date)){ diff --git a/R/formatCheckParameterCd.r b/R/formatCheckParameterCd.r index bd47ff532a85fb8e358769649c565b1884f69e89..550f012ead20db82e68f16ede3d1538a24d3b19b 100644 --- a/R/formatCheckParameterCd.r +++ b/R/formatCheckParameterCd.r @@ -1,14 +1,3 @@ -#' Parameter Code Check -#' -#' Checks that the user-supplied parameter code is 5 digits. If not, asks the user to re-enter. -#' -#' @param ParameterCd string USGS parameter code -#' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. -#' @keywords data import from web service -#' @return ParameterCd string -#' @export -#' @examples -#' formatCheckParameterCd('00060') formatCheckParameterCd <- function(ParameterCd, interactive=TRUE){ #checks for a 5 digit number if (nchar(ParameterCd) != 5){ if (interactive){ diff --git a/R/formatCheckSiteNumber.r b/R/formatCheckSiteNumber.r index 091f95a714e4edf0f23acbf97eea97c1b9e31f89..f8597fbc907baa7e1cb5382a13a790a934ee995e 100644 --- a/R/formatCheckSiteNumber.r +++ b/R/formatCheckSiteNumber.r @@ -1,16 +1,3 @@ -#' Site number check -#' -#' Checks that the user-supplied site number is 8 digits, typical for many USGS station site id's.If not, asks the user to re-enter. -#' The final siteNumber can be more or less than 8 digits, since there are conditions where that is the case. -#' -#' @param siteNumber string USGS site number -#' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. -#' @keywords error checking for data import from web service -#' @return siteNumber string -#' @export -#' @examples -#' formatCheckSiteNumber('01594440') -#' formatCheckSiteNumber('015944400',interactive=FALSE) formatCheckSiteNumber <- function(siteNumber, interactive=TRUE){ #checks for a 8 digit number if (nchar(siteNumber) != 8){ if (interactive){ diff --git a/R/retrieveNWISData.r b/R/retrieveNWISData.r index 0035a85c81a3f0267d1de7e64e3a1207a6085df7..6e56115060db05cbf776b403890c0212383220a0 100644 --- a/R/retrieveNWISData.r +++ b/R/retrieveNWISData.r @@ -1,4 +1,4 @@ -#' Data Import for USGS NWIS Data +#' Raw Data Import for USGS NWIS Data #' #' Imports data from NWIS web service. This function gets the data from here: \url{http://waterservices.usgs.gov/} #' A list of parameter codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes/} diff --git a/R/retrieveUnitNWISData.r b/R/retrieveUnitNWISData.r index 7305cfd93bb15fe0b2f39cdf335423b4b7796582..0fd5b25e294aa381808024cfb82db6c9016dcef2 100644 --- a/R/retrieveUnitNWISData.r +++ b/R/retrieveUnitNWISData.r @@ -1,4 +1,4 @@ -#' Data Import for Instantaneous USGS NWIS Data +#' Raw Data Import for Instantaneous USGS NWIS Data #' #' Imports data from NWIS web service. This function gets the data from here: \url{http://waterservices.usgs.gov/} #' A list of parameter codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes/} @@ -20,11 +20,15 @@ #' # These examples require an internet connection to run #' rawData <- retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE) retrieveUnitNWISData <- function (siteNumber,ParameterCd,StartDate,EndDate,interactive=TRUE){ + + # Checking for 8 digit site ID: siteNumber <- formatCheckSiteNumber(siteNumber, interactive=interactive) + # Check for 5 digit parameter code: ParameterCd <- formatCheckParameterCd(ParameterCd, interactive=interactive) + # Check date format: StartDate <- formatCheckDate(StartDate, "StartDate", interactive=interactive) EndDate <- formatCheckDate(EndDate, "EndDate", interactive=interactive) - + #Check that dateReturn <- checkStartEndDate(StartDate, EndDate, interactive=interactive) StartDate <- dateReturn[1] EndDate <- dateReturn[2] diff --git a/R/tabbedDataRetrievals.R b/R/tabbedDataRetrievals.R index e3e17927f7ffc1fcefe925c0422273ba6dc187e7..702d98a6f2db5b075668f927e2a7197ca767e84d 100644 --- a/R/tabbedDataRetrievals.R +++ b/R/tabbedDataRetrievals.R @@ -47,13 +47,27 @@ NULL #' Flux units included in dataRetrieval #' -#' Flux units +#' Flux units included: +#' \tabular{lllll}{ +#' Number \tab ObjectName \tab shortName \tab unitFactor \tab unitName \cr +#' 1 \tab POUNDS_DAY \tab lbs/day \tab 2.204623 \tab pounds/day\cr +#' 2 \tab TONS_DAY \tab tons/day \tab 0.001102 \tab tons/day \cr +#' 3 \tab KG_DAY \tab kg/day \tab 1 \tab kg/day \cr +#' 4 \tab THOUSAND_KG_DAY\tab 10^3 kg/day \tab 0.001 \tab "thousands of kg/day\cr +#' 5 \tab TONS_YEAR\tab tons/yr \tab 0.402619 \tab tons/year\cr +#' 6 \tab THOUSAND_TONS_YEAR\tab 10^3 tons/yr \tab 0.000402619 \tab thousands of tons/year \cr +#' 7 \tab MILLION_TONS_YEAR\tab 10^6 tons/yr \tab 4.02619e-07 \tab millions of tons/year\cr +#' 8 \tab THOUSAND_KG_YEAR\tab 10^3 kg/yr \tab 0.36525 \tab thousands of kg/year\cr +#' 9 \tab MILLION_KG_YEAR\tab 10^6 kg/yr \tab 0.00036525 \tab millions of kg/year\cr +#' 10 \tab BILLION_KG_YEAR\tab 10^9 kg/yr \tab 3.6525e-07 \tab billions of kg/year \cr +#' } +#' #' #' @name FLUX_UNIT #' @docType data NULL -#' Sample Dataframe included in dataRetrieval +#' Example Sample Dataframe included in dataRetrieval #' #' Initial Sample data frame from the Choptank River #' @@ -63,7 +77,7 @@ NULL #' @keywords water flow data NULL -#' Daily Dataframe included in dataRetrieval +#' Example Daily Dataframe included in dataRetrieval #' #' Initial Daily data frame from the Choptank River #' diff --git a/inst/doc/dataRetrieval.Rnw b/inst/doc/dataRetrieval.Rnw index d3ca53f0c6349c44f06bb4d6382fe32660ea940a..09438ca7f9d6da07ced00be355f0ecdba710925a 100644 --- a/inst/doc/dataRetrieval.Rnw +++ b/inst/doc/dataRetrieval.Rnw @@ -57,7 +57,7 @@ %------------------------------------------------------------ \section{Introduction to dataRetrieval} %------------------------------------------------------------ -The dataRetrieval package was created to simplify the process of getting hydrologic data in the R enviornment. It has been specifically designed to work seamlessly with the EGRET package: Exploration and Graphics for RivEr Trends (EGRET) . +The dataRetrieval package was created to simplify the process of getting hydrologic data in the R enviornment. It has been specifically designed to work seamlessly with the EGRET package: Exploration and Graphics for RivEr Trends (EGRET). %------------------------------------------------------------ \subsection{What is dataRetrieval?} diff --git a/man/FLUX_UNIT.Rd b/man/FLUX_UNIT.Rd index 29f78d501c37a5386dabc09d36f65f6264079b5c..ba1bbcc5cea7e34efd18c350eaf9d3ce6b44ce59 100644 --- a/man/FLUX_UNIT.Rd +++ b/man/FLUX_UNIT.Rd @@ -3,7 +3,22 @@ \alias{FLUX_UNIT} \title{Flux units included in dataRetrieval} \description{ - Flux units + Flux units included: \tabular{lllll}{ Number \tab + ObjectName \tab shortName \tab unitFactor \tab unitName + \cr 1 \tab POUNDS_DAY \tab lbs/day \tab 2.204623 \tab + pounds/day\cr 2 \tab TONS_DAY \tab tons/day \tab 0.001102 + \tab tons/day \cr 3 \tab KG_DAY \tab kg/day \tab 1 \tab + kg/day \cr 4 \tab THOUSAND_KG_DAY\tab 10^3 kg/day \tab + 0.001 \tab "thousands of kg/day\cr 5 \tab TONS_YEAR\tab + tons/yr \tab 0.402619 \tab tons/year\cr 6 \tab + THOUSAND_TONS_YEAR\tab 10^3 tons/yr \tab 0.000402619 \tab + thousands of tons/year \cr 7 \tab MILLION_TONS_YEAR\tab + 10^6 tons/yr \tab 4.02619e-07 \tab millions of + tons/year\cr 8 \tab THOUSAND_KG_YEAR\tab 10^3 kg/yr \tab + 0.36525 \tab thousands of kg/year\cr 9 \tab + MILLION_KG_YEAR\tab 10^6 kg/yr \tab 0.00036525 \tab + millions of kg/year\cr 10 \tab BILLION_KG_YEAR\tab 10^9 + kg/yr \tab 3.6525e-07 \tab billions of kg/year \cr } } \keyword{datasets} diff --git a/man/checkStartEndDate.Rd b/man/checkStartEndDate.Rd deleted file mode 100644 index 4d07eca6c741c3a9307b49c4606a9e7136ca3b85..0000000000000000000000000000000000000000 --- a/man/checkStartEndDate.Rd +++ /dev/null @@ -1,32 +0,0 @@ -\name{checkStartEndDate} -\alias{checkStartEndDate} -\title{Check Start End Dates} -\usage{ - checkStartEndDate(StartDate, EndDate, interactive = TRUE) -} -\arguments{ - \item{StartDate}{string date} - - \item{EndDate}{string date} - - \item{interactive}{logical Option for interactive mode. - If true, there is user interaction for error handling and - data checks.} -} -\value{ - list StartDate,EndDate -} -\description{ - Checks that the user-supplied starting date is before the - ending date. If not, either the user can re-enter, or - the dates will be set to maximum. -} -\examples{ -checkStartEndDate('1985-01-01', '1985-12-31') -} -\keyword{data} -\keyword{from} -\keyword{import} -\keyword{service} -\keyword{web} - diff --git a/man/dateFormatCheck.Rd b/man/dateFormatCheck.Rd deleted file mode 100644 index 99e2f1a9ac7fa933a5ecbb9c9f5c2134b3f92f07..0000000000000000000000000000000000000000 --- a/man/dateFormatCheck.Rd +++ /dev/null @@ -1,27 +0,0 @@ -\name{dateFormatCheck} -\alias{dateFormatCheck} -\title{Date Formatting Check} -\usage{ - dateFormatCheck(date) -} -\arguments{ - \item{date}{string date to check} -} -\value{ - Date logical -} -\description{ - Checks that the user-supplied date is in the format - YYYY-MM-DD and month is less than 13, and dates are less - than 32. -} -\examples{ -dateFormatCheck('1985-01-01') -dateFormatCheck('01/01/1985') -} -\keyword{data} -\keyword{from} -\keyword{import} -\keyword{service} -\keyword{web} - diff --git a/man/exDaily.Rd b/man/exDaily.Rd index 8223d40dea316a92af074d589475b447e56fae1b..c37bd17e3e861e0516a380d1fea83481c5d14199 100644 --- a/man/exDaily.Rd +++ b/man/exDaily.Rd @@ -1,7 +1,7 @@ \docType{data} \name{exDaily} \alias{exDaily} -\title{Daily Dataframe included in dataRetrieval} +\title{Example Daily Dataframe included in dataRetrieval} \description{ Initial Daily data frame from the Choptank River } diff --git a/man/exSample.Rd b/man/exSample.Rd index ea7f508770e40630c3a7d0fee235011bd1b1b372..efe98d6a476037a7dd2c9bfc6e2bc1e7059d4e0a 100644 --- a/man/exSample.Rd +++ b/man/exSample.Rd @@ -1,7 +1,7 @@ \docType{data} \name{exSample} \alias{exSample} -\title{Sample Dataframe included in dataRetrieval} +\title{Example Sample Dataframe included in dataRetrieval} \description{ Initial Sample data frame from the Choptank River } diff --git a/man/formatCheckDate.Rd b/man/formatCheckDate.Rd deleted file mode 100644 index fe29c963a4ce094c1ae728507223d011e50202b0..0000000000000000000000000000000000000000 --- a/man/formatCheckDate.Rd +++ /dev/null @@ -1,32 +0,0 @@ -\name{formatCheckDate} -\alias{formatCheckDate} -\title{Date Formatting Correction} -\usage{ - formatCheckDate(Date, dateString, interactive = TRUE) -} -\arguments{ - \item{Date}{string date to check} - - \item{dateString}{string should be either 'StartDate' or - 'EndDate'} - - \item{interactive}{logical Option for interactive mode. - If true, there is user interaction for error handling and - data checks.} -} -\value{ - Date string -} -\description{ - Checks that the user-supplied date is in the format - YYYY-MM-DD. If not, asks the user to re-enter. -} -\examples{ -formatCheckDate('1985-01-01', 'StartDate') -} -\keyword{data} -\keyword{from} -\keyword{import} -\keyword{service} -\keyword{web} - diff --git a/man/formatCheckParameterCd.Rd b/man/formatCheckParameterCd.Rd deleted file mode 100644 index ab2b22680157daa9faea7e1c613cdfdabe7f0fba..0000000000000000000000000000000000000000 --- a/man/formatCheckParameterCd.Rd +++ /dev/null @@ -1,29 +0,0 @@ -\name{formatCheckParameterCd} -\alias{formatCheckParameterCd} -\title{Parameter Code Check} -\usage{ - formatCheckParameterCd(ParameterCd, interactive = TRUE) -} -\arguments{ - \item{ParameterCd}{string USGS parameter code} - - \item{interactive}{logical Option for interactive mode. - If true, there is user interaction for error handling and - data checks.} -} -\value{ - ParameterCd string -} -\description{ - Checks that the user-supplied parameter code is 5 digits. - If not, asks the user to re-enter. -} -\examples{ -formatCheckParameterCd('00060') -} -\keyword{data} -\keyword{from} -\keyword{import} -\keyword{service} -\keyword{web} - diff --git a/man/formatCheckSiteNumber.Rd b/man/formatCheckSiteNumber.Rd deleted file mode 100644 index f3aaed3be6f517a5b56c8cf9d3050dc67da377c8..0000000000000000000000000000000000000000 --- a/man/formatCheckSiteNumber.Rd +++ /dev/null @@ -1,36 +0,0 @@ -\name{formatCheckSiteNumber} -\alias{formatCheckSiteNumber} -\title{Site number check} -\usage{ - formatCheckSiteNumber(siteNumber, interactive = TRUE) -} -\arguments{ - \item{siteNumber}{string USGS site number} - - \item{interactive}{logical Option for interactive mode. - If true, there is user interaction for error handling and - data checks.} -} -\value{ - siteNumber string -} -\description{ - Checks that the user-supplied site number is 8 digits, - typical for many USGS station site id's.If not, asks the - user to re-enter. The final siteNumber can be more or - less than 8 digits, since there are conditions where that - is the case. -} -\examples{ -formatCheckSiteNumber('01594440') -formatCheckSiteNumber('015944400',interactive=FALSE) -} -\keyword{checking} -\keyword{data} -\keyword{error} -\keyword{for} -\keyword{from} -\keyword{import} -\keyword{service} -\keyword{web} - diff --git a/man/retrieveNWISData.Rd b/man/retrieveNWISData.Rd index ae1547e621824f26cf30b3cdd912228a8d394d5f..e21541d8c67efe9ce0856b6f884c70360b209e33 100644 --- a/man/retrieveNWISData.Rd +++ b/man/retrieveNWISData.Rd @@ -1,6 +1,6 @@ \name{retrieveNWISData} \alias{retrieveNWISData} -\title{Data Import for USGS NWIS Data} +\title{Raw Data Import for USGS NWIS Data} \usage{ retrieveNWISData(siteNumber, ParameterCd, StartDate, EndDate, StatCd = "00003", interactive = TRUE) diff --git a/man/retrieveUnitNWISData.Rd b/man/retrieveUnitNWISData.Rd index fa6f1488b55198eb1ba50233609929a72156c75a..3509d78c2d1b564df74ee7b80769b3920cf5df20 100644 --- a/man/retrieveUnitNWISData.Rd +++ b/man/retrieveUnitNWISData.Rd @@ -1,6 +1,6 @@ \name{retrieveUnitNWISData} \alias{retrieveUnitNWISData} -\title{Data Import for Instantaneous USGS NWIS Data} +\title{Raw Data Import for Instantaneous USGS NWIS Data} \usage{ retrieveUnitNWISData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE)