diff --git a/R/getDVData.r b/R/getDVData.r index 73db3b143084621b99a73fc8dd51390e88105056..ff8ffd4a2c025f0bbfbdcfc8c54da461df527583 100644 --- a/R/getDVData.r +++ b/R/getDVData.r @@ -15,7 +15,7 @@ #' @seealso \code{\link{retrieveNWISData}}, \code{\link{populateDaily}} #' @examples #' # These examples require an internet connection to run -#' getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) +#' Daily <- getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) getDVData <- function (siteNumber,ParameterCd,StartDate,EndDate,interactive=TRUE){ data <- retrieveNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=interactive) # need to setup conversion factor because the NWIS data are in cfs but we store in cms diff --git a/R/getMetaData.r b/R/getMetaData.r index 0ae856e967cdeb34d6f83a7b207fed81f5f5fac9..1d5d3951137a8b2a2b3386e206b3deb6e57f1825 100644 --- a/R/getMetaData.r +++ b/R/getMetaData.r @@ -17,7 +17,7 @@ #' @examples #' # These examples require an internet connection to run #' # Automatically gets information about site 05114000 and temperature, no interaction with user -#' getMetaData('05114000','00010',interactive=FALSE) +#' INFO <- getMetaData('05114000','00010',interactive=FALSE) getMetaData <- function(siteNumber="", parameterCd="",interactive=TRUE){ if (nzchar(siteNumber)){ INFO <- getSiteFileData(siteNumber,interactive=interactive) @@ -35,7 +35,7 @@ getMetaData <- function(siteNumber="", parameterCd="",interactive=TRUE){ INFO$paramNumber <- parameterData$parameter_cd } - INFO <- populateParameterINFO(INFO, parameterCd, interactive=interactive) + INFO <- populateParameterINFO(parameterCd, INFO, interactive=interactive) return(INFO) } \ No newline at end of file diff --git a/R/getParameterInfo.r b/R/getParameterInfo.r index 6dcff534466ae6f2511189694099395298109c2c..2dd762305f57567ae0b7a401ac32d4ae19611025 100644 --- a/R/getParameterInfo.r +++ b/R/getParameterInfo.r @@ -10,8 +10,8 @@ #' @export #' @examples #' # These examples require an internet connection to run -#' getParameterInfo('01075') -#' getParameterInfo('00931',interactive=FALSE) +#' paramINFO <- getParameterInfo('01075') +#' paramINFO2 <- getParameterInfo('00931',interactive=FALSE) getParameterInfo <- function(parameterCd,interactive=TRUE){ parameterCd <- formatCheckParameterCd(parameterCd, interactive=interactive) urlParameterCd <- paste("http://nwis.waterdata.usgs.gov/nwis/pmcodes/?radio_pm_search=pm_search&pm_search=",parameterCd,"&casrn_search=&srsname_search=&format=rdb_file&show=parameter_group_nm&show=parameter_nm&show=casrn&show=srsname&show=parameter_units",sep="") diff --git a/R/getPreLoadedDailyData.r b/R/getPreLoadedDailyData.r index ce008449d0f5ff5a391d1f624bb664a13c06b561..d8d275d1944a94128bff1a142c18068e592cd126 100644 --- a/R/getPreLoadedDailyData.r +++ b/R/getPreLoadedDailyData.r @@ -9,7 +9,7 @@ #' @export #' @return Daily dataframe #' @examples -#' getPreLoadedDailyData(ChoptankRiverFlow, interactive=FALSE) +#' Daily <- getPreLoadedDailyData(ChoptankRiverFlow, interactive=FALSE) getPreLoadedDailyData <- function (loadedData,qUnit=1,interactive=TRUE){ data <- getPreLoadedData(loadedData) convertQ<-c(35.314667,1) diff --git a/R/getPreLoadedData.r b/R/getPreLoadedData.r index 61ce0db1781c1999d08c17f2b6ba1fe80fcecef8..3ad1fde908066fa6c694cfc07a9a1b16ac37a314 100644 --- a/R/getPreLoadedData.r +++ b/R/getPreLoadedData.r @@ -9,7 +9,7 @@ #' @return retval dataframe with dateTime, value, and code columns #' @export #' @examples -#' getPreLoadedData(ChoptankRiverFlow) +#' rawData <- getPreLoadedData(ChoptankRiverFlow) getPreLoadedData <- function (rawData){ retval <- as.data.frame(rawData, stringsAsFactors=FALSE) if(ncol(retval) == 2){ diff --git a/R/getQWData.r b/R/getQWData.r index 6e760763b4405be9bad31ca144b45edebb4be540..da2029e1c00d68a79cb791d543549ac0e4971abe 100644 --- a/R/getQWData.r +++ b/R/getQWData.r @@ -15,9 +15,9 @@ #' @export #' @examples #' # These examples require an internet connection to run -#' getQWData('01594440','01075', '1985-01-01', '1985-03-31') -#' getQWData('05114000','', '1985-01-01', '1985-03-31') -#' getQWData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE) +#' rawSample <- getQWData('01594440','01075', '1985-01-01', '1985-03-31') +#' rawSampleAll <- getQWData('05114000','', '1985-01-01', '1985-03-31') +#' rawSampleSelect <- getQWData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE) getQWData <- function(siteNumber,ParameterCd,StartDate,EndDate,interactive=TRUE){ siteNumber <- formatCheckSiteNumber(siteNumber, interactive=interactive) StartDate <- formatCheckDate(StartDate, "StartDate", interactive=interactive) diff --git a/R/getQWDataFromFile.r b/R/getQWDataFromFile.r index de4ba97a6c0225182e0c312537c8809fd34303fc..f9fb272366a5373b70f2dd6a9972e61af88c6479 100644 --- a/R/getQWDataFromFile.r +++ b/R/getQWDataFromFile.r @@ -15,9 +15,9 @@ #' @examples #' # Examples of how to use getQWDataFromFile: #' # Change the file path and file name to something meaningful: -#' #filePath <- '~/RData/' # Sample format +#' filePath <- '~/RData/' # Sample format #' fileName <- 'ChoptankRiverNitrate.csv' -#' #getQWDataFromFile(filePath,fileName, separator=";") +#' #rawSampleData <- getQWDataFromFile(filePath,fileName, separator=";") getQWDataFromFile <- function (filePath,fileName,hasHeader=TRUE,separator=","){ totalPath <- paste(filePath,fileName,sep=""); tmp <- read.delim( diff --git a/R/getSampleData.r b/R/getSampleData.r index 7058961b2b5de832b04b505cb3ff79cb3c6e2c41..a9a49273d2e6b9820db4fc9cf0561b0a50f21404 100644 --- a/R/getSampleData.r +++ b/R/getSampleData.r @@ -3,6 +3,8 @@ #' Imports data from NWIS web service. This function gets the data from here: \url{http://qwwebservices.usgs.gov/} #' A list of parameter codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes/} #' A list of statistic codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} +#' For raw data, use getQWData. This function will retrieve the raw data, and compress it (summing constituents). See +#' chapter 7 of the EGRET user guide for more details. #' #' @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. @@ -15,9 +17,9 @@ #' @seealso \code{\link{compressData}}, \code{\link{populateSampleColumns}} #' @examples #' # These examples require an internet connection to run -#' getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) -#' getSampleData('05114000','00915;00931', '1985-01-01', '1985-03-31', interactive=FALSE) -#' getSampleData('05114000','00915;00931', '', '', interactive=FALSE) +#' Sample_01075 <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) +#' Sample_All <- getSampleData('05114000','00915;00931', '1985-01-01', '1985-03-31', interactive=FALSE) +#' Sample_Select <- getSampleData('05114000','00915;00931', '', '', interactive=FALSE) getSampleData <- function(siteNumber,ParameterCd,StartDate,EndDate,interactive=TRUE){ data <- getQWData(siteNumber,ParameterCd,StartDate,EndDate,interactive=interactive) compressedData <- compressData(data, interactive=interactive) diff --git a/R/getSampleDataFromFile.r b/R/getSampleDataFromFile.r index d53e5eea895a38a7a8ef36ab3b21b2874d8b9e61..c08e175f5484eabb0995165c00bfc8d2c0ca4530 100644 --- a/R/getSampleDataFromFile.r +++ b/R/getSampleDataFromFile.r @@ -14,9 +14,9 @@ #' @examples #' # Examples of how to use getSampleDataFromFile: #' # Change the file path and file name to something meaningful: -#' #filePath <- '~/RData/' # Sample format +#' filePath <- '~/RData/' # Sample format #' fileName <- 'ChoptankRiverNitrate.csv' -#' #getSampleDataFromFile(filePath,fileName, separator=";",interactive=FALSE) +#' #Sample <- getSampleDataFromFile(filePath,fileName, separator=";",interactive=FALSE) getSampleDataFromFile <- function (filePath,fileName,hasHeader=TRUE,separator=",", interactive=TRUE){ data <- getQWDataFromFile(filePath,fileName,hasHeader=hasHeader,separator=separator) compressedData <- compressData(data, interactive=interactive) diff --git a/R/getSiteFileData.r b/R/getSiteFileData.r index b15f9edb45d8832fc662c429e5a6a8a804bfe223..cae4cec117e8ed1ecdf6ae2d9cf118cfdc3d035c 100644 --- a/R/getSiteFileData.r +++ b/R/getSiteFileData.r @@ -9,7 +9,7 @@ #' @export #' @examples #' # These examples require an internet connection to run -#' getSiteFileData('05114000',interactive=FALSE) +#' siteINFO <- getSiteFileData('05114000',interactive=FALSE) getSiteFileData <- function(siteNumber="",interactive=TRUE){ siteNumber <- formatCheckSiteNumber(siteNumber, interactive=interactive) urlSitefile <- paste("http://waterservices.usgs.gov/nwis/site?format=rdb&siteOutput=Expanded&sites=",siteNumber,sep = "") diff --git a/R/mergeReport.r b/R/mergeReport.r index d9d25ab7b0060e6c858ce7976356bc9c3babfc81..f8256544256be3ff08f81b0e33ee720fa4f1e57e 100644 --- a/R/mergeReport.r +++ b/R/mergeReport.r @@ -11,9 +11,9 @@ #' @seealso \code{\link{getDVData}}, \code{\link{populateSampleColumns}} #' @examples #' # These examples require an internet connection to run -#' exDaily <- getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) -#' exSample <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) -#' mergeReport(localDaily = exDaily, localSample = exSample, interactive=FALSE) +#' Daily <- getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) +#' Sample <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) +#' Sample <- mergeReport(interactive=FALSE) mergeReport<-function(localDaily = Daily, localSample = Sample, interactive=TRUE){ if (interactive){ dataOverview(localDaily, localSample) diff --git a/R/populateConcentrations.r b/R/populateConcentrations.r index 5724033da1eee47703ea5d9bb22315fce4c7e1c8..ea5400636b3306477a846b587469db0e26ca78f7 100644 --- a/R/populateConcentrations.r +++ b/R/populateConcentrations.r @@ -9,7 +9,7 @@ #' code <- c("","<","") #' value <- c(1,2,3) #' dataInput <- data.frame(value, code, stringsAsFactors=FALSE) -#' populateConcentrations(dataInput) +#' concentrationDF <- populateConcentrations(dataInput) populateConcentrations <- function(rawData){ # rawData is a dataframe with value, code concentrationColumns <- as.data.frame(matrix(ncol=3,nrow=length(rawData$value))) colnames(concentrationColumns) <- c('ConcLow','ConcHigh','Uncen') diff --git a/R/populateDaily.r b/R/populateDaily.r index 43118f4ca22ed84c0717c135dd503578cc4c90d5..fa9bac2ae84083aad8e0171a339f1ab59b39e270 100644 --- a/R/populateDaily.r +++ b/R/populateDaily.r @@ -15,7 +15,7 @@ #' value <- c(1,2,3) #' code <- c("","","") #' dataInput <- data.frame(dateTime, value, code, stringsAsFactors=FALSE) -#' populateDaily(dataInput, 2, interactive=FALSE) +#' Daily <- populateDaily(dataInput, 2, interactive=FALSE) populateDaily <- function(rawData,qConvert,interactive=TRUE){ # rawData is a dataframe with at least dateTime, value, code localDaily <- as.data.frame(matrix(ncol=2,nrow=length(rawData$value))) colnames(localDaily) <- c('Date','Q') diff --git a/R/populateDateColumns.r b/R/populateDateColumns.r index 591cf82d2e2d12c41d5baefe7a5cb9db5765136a..76b956c2254b885cd5a2facd15d71f20f73a3829 100644 --- a/R/populateDateColumns.r +++ b/R/populateDateColumns.r @@ -7,7 +7,7 @@ #' @export #' @examples #' dateTime <- c('1985-01-01', '1985-01-02', '1985-01-03') -#' populateDateColumns(dateTime) +#' expandedDateDF <- populateDateColumns(dateTime) populateDateColumns <- function(rawData){ # rawData is a vector of dates DateFrame <- as.data.frame(matrix(ncol=1,nrow=length(rawData))) colnames(DateFrame) <- c('Date') diff --git a/R/populateParameterINFO.r b/R/populateParameterINFO.r index d61d1fc43187b517937e08495d4737af99a45f37..557cacf02438ae4c9289d4b40350f612930b149d 100644 --- a/R/populateParameterINFO.r +++ b/R/populateParameterINFO.r @@ -2,54 +2,54 @@ #' #' Populates INFO data frame with additional user-supplied information concerning the measured parameter. #' -#' @param INFO dataframe with value and code columns +#' @param localINFO dataframe with value and code columns. Default is INFO #' @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. -#' @return INFO dataframe +#' @return localINFO dataframe #' @export #' @examples #' #This example requires an internet connection to run -#' exINFO <- getSiteFileData('01594440') +#' INFO <- getSiteFileData('01594440') #' parameterCd <- "00175" #' parameterData <- getParameterInfo(parameterCd,interactive=interactive) -#' exINFO$param.nm <- parameterData$parameter_nm -#' exINFO$param.units <- parameterData$parameter_units -#' exINFO$paramShortName <- parameterData$srsname -#' exINFO$paramNumber <- parameterData$parameter_cd -#' populateParameterINFO(exINFO, parameterCd,interactive=FALSE) -populateParameterINFO <- function(INFO, parameterCd, interactive=TRUE){ +#' INFO$param.nm <- parameterData$parameter_nm +#' INFO$param.units <- parameterData$parameter_units +#' INFO$paramShortName <- parameterData$srsname +#' INFO$paramNumber <- parameterData$parameter_cd +#' INFO <- populateParameterINFO(parameterCd,interactive=FALSE) +populateParameterINFO <- function(parameterCd, localINFO=INFO, interactive=TRUE){ if (nzchar(parameterCd)){ if(interactive){ - cat("Your water quality data are for parameter number", INFO$paramNumber, "which has the name:'", INFO$param.nm, "'.\n") - cat("Typically you will want a shorter name to be used in graphs and tables. The suggested short name is:'", INFO$paramShortName, "'.\n") + cat("Your water quality data are for parameter number", localINFO$paramNumber, "which has the name:'", localINFO$param.nm, "'.\n") + cat("Typically you will want a shorter name to be used in graphs and tables. The suggested short name is:'", localINFO$paramShortName, "'.\n") cat("If you would like to change the short name, enter it here, otherwise just hit enter (no quotes):") shortNameTemp <- readline() - if (nchar(shortNameTemp)>0) INFO$paramShortName <- shortNameTemp - cat("The units for the water quality data are: ", INFO$param.units, ".\n") + if (nchar(shortNameTemp)>0) localINFO$paramShortName <- shortNameTemp + cat("The units for the water quality data are: ", localINFO$param.units, ".\n") cat("It is helpful to set up a constiuent abbreviation when doing multi-constituent studies, enter a unique id (three or four characters should work something like tn or tp or NO3).\nIt is case sensitive. Even if you don't feel you need an abbreviation you need to enter something (no quotes):\n") - INFO$constitAbbrev <- readline() + localINFO$constitAbbrev <- readline() } else { - INFO$constitAbbrev <- INFO$paramShortName + localINFO$constitAbbrev <- localINFO$paramShortName } } else { if (interactive){ - INFO$paramNumber <- NA + localINFO$paramNumber <- NA cat("Enter a long name for the water quality data (no quotes):\n") - INFO$param.nm <- readline() + localINFO$param.nm <- readline() cat("Enter a short name to be used in graphs and tables(no quotes):\n") - INFO$paramShortName <- readline() + localINFO$paramShortName <- readline() cat("It is helpful to set up a constiuent abbreviation when doing multi-constituent studies, enter a unique id (three or four characters should work something like tn or tp or NO3).\nIt is case sensitive. Even if you don't feel you need an abbreviation you need to enter something (no quotes):\n") - INFO$constitAbbrev <- readline() + localINFO$constitAbbrev <- readline() cat("Enter the units of the water quality data(no quotes):\n") - INFO$param.units <- readline() + localINFO$param.units <- readline() } else { - INFO$paramNumber <- NA - INFO$param.nm <- NA - INFO$paramShortName <- NA - INFO$constitAbbrev <- NA - INFO$param.units <- NA + localINFO$paramNumber <- NA + localINFO$param.nm <- NA + localINFO$paramShortName <- NA + localINFO$constitAbbrev <- NA + localINFO$param.units <- NA } } - return(INFO) + return(localINFO) } \ No newline at end of file diff --git a/R/populateSampleColumns.r b/R/populateSampleColumns.r index 8571df6acc0e099e858c17a894d73ea22534c61c..7e7cabb7a39b9544494144cfc49fa96e67da9947 100644 --- a/R/populateSampleColumns.r +++ b/R/populateSampleColumns.r @@ -11,7 +11,7 @@ #' ConcHigh <- c(1,2,3) #' Uncen <- c(1,1,0) #' dataInput <- data.frame(dateTime, ConcLow, ConcHigh, Uncen, stringsAsFactors=FALSE) -#' populateSampleColumns(dataInput) +#' Sample <- populateSampleColumns(dataInput) populateSampleColumns <- function(rawData){ # rawData is a dataframe with dateTime, ConcLow, ConcHigh, Uncen Sample <- as.data.frame(matrix(ncol=3,nrow=length(rawData$dateTime))) colnames(Sample) <- c('Date', 'ConcLow','ConcHigh') diff --git a/R/populateSiteINFO.r b/R/populateSiteINFO.r index 53fae27e73effa83e7a7a4f6cae8e6c06d50a2ad..5ec04b2ce5920a118e025556a9a0eea8dcb1d95c 100644 --- a/R/populateSiteINFO.r +++ b/R/populateSiteINFO.r @@ -9,9 +9,9 @@ #' @export #' @examples #' #This example requires an internet connection to run -#' exINFO <- getSiteFileData('01594440') +#' INFO <- getSiteFileData('01594440') #' siteNumber <- "01594440" -#' populateSiteINFO(exINFO, siteNumber,interactive=FALSE) +#' siteINFO <- populateSiteINFO(INFO, siteNumber,interactive=FALSE) populateSiteINFO <- function(INFO, siteNumber,interactive=TRUE){ if (nzchar(siteNumber)){ diff --git a/R/retrieveNWISData.r b/R/retrieveNWISData.r index 1b4d3105934095d8a91a5e6a64a9002e48351744..0035a85c81a3f0267d1de7e64e3a1207a6085df7 100644 --- a/R/retrieveNWISData.r +++ b/R/retrieveNWISData.r @@ -15,8 +15,8 @@ #' @export #' @examples #' # These examples require an internet connection to run -#' retrieveNWISData('01594440','00060', '1985-01-01', '1985-01-31') -#' retrieveNWISData('05114000','00010', '1985-01-01', '1985-01-31', StatCd='00001',interactive=FALSE) +#' rawDailyFlowData <- retrieveNWISData('01594440','00060', '1985-01-01', '1985-01-31') +#' rawDailyTemperatureData <- retrieveNWISData('05114000','00010', '1985-01-01', '1985-01-31', StatCd='00001',interactive=FALSE) retrieveNWISData <- function (siteNumber,ParameterCd,StartDate,EndDate,StatCd="00003",interactive=TRUE){ siteNumber <- formatCheckSiteNumber(siteNumber, interactive=interactive) ParameterCd <- formatCheckParameterCd(ParameterCd, interactive=interactive) diff --git a/R/retrieveUnitNWISData.r b/R/retrieveUnitNWISData.r index ccac4fa6d42a23b49b53bfcc8cfdca694429a8d1..6a708da4029bbf8058bc08f9d0ff3e18d92746c6 100644 --- a/R/retrieveUnitNWISData.r +++ b/R/retrieveUnitNWISData.r @@ -11,7 +11,7 @@ #' @param StatCd string USGS statistic code. This is usually 5 digits. Daily mean (00003) is the default. #' @param interactive logical Option for interactive mode. If true, there is user interaction for error handling and data checks. #' @keywords data import USGS web service -#' @return retval dataframe with agency, site, dateTime, value, and code columns +#' @return retval dataframe with agency, site, dateTime, time zone, value, and code columns #' @export #' @examples #' siteNumber <- '05114000' @@ -19,7 +19,7 @@ #' StartDate <- '2012-05-01' #' EndDate <- '2012-05-02' #' # These examples require an internet connection to run -#' retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE) +#' rawData <- retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE) retrieveUnitNWISData <- function (siteNumber,ParameterCd,StartDate,EndDate,interactive=TRUE){ siteNumber <- formatCheckSiteNumber(siteNumber, interactive=interactive) ParameterCd <- formatCheckParameterCd(ParameterCd, interactive=interactive) diff --git a/R/tabbedDataRetrievals.R b/R/tabbedDataRetrievals.R index 55b16856cf8d399cef361a4dff939e3c68c899c7..61cc7d1441882fa072a066ef7d349cd8766354f8 100644 --- a/R/tabbedDataRetrievals.R +++ b/R/tabbedDataRetrievals.R @@ -4,8 +4,12 @@ #' Package: \tab dataRetrieval\cr #' Type: \tab Package\cr #' Version: \tab 1.0.4\cr -#' Date: \tab 2012-06-19\cr -#' License: \tab GPL (>= 2)\cr +#' Date: \tab 2012-12-31\cr +#' License: \tab This software is in the public domain because it contains materials +#' that originally came from the United States Geological Survey, an agency of +#' the United States Department of Interior. For more information, see the +#' official USGS copyright policy at +#' http://www.usgs.gov/visual-id/credit_usgs.html#copyright\cr #' LazyLoad: \tab yes\cr #' } #' diff --git a/inst/doc/dataRetrieval.log b/inst/doc/dataRetrieval.log index b1d6335636b93636e3155455a46274e12674a4e5..0247f4f4fba30881b03efa06fe97975f22ce4ca0 100644 --- a/inst/doc/dataRetrieval.log +++ b/inst/doc/dataRetrieval.log @@ -1,7 +1,7 @@ -This is pdfTeX, Version 3.1415926-2.3-1.40.12 (MiKTeX 2.9) (preloaded format=pdflatex 2012.1.6) 29 OCT 2012 09:14 +This is pdfTeX, Version 3.1415926-2.3-1.40.12 (MiKTeX 2.9) (preloaded format=pdflatex 2012.1.6) 28 DEC 2012 15:13 entering extended mode **dataRetrieval.tex -(D:\LADData\RCode\dataRetrieval\master\inst\doc\dataRetrieval.tex +(D:\LADData\RCode\dataRetrievalGitorious\inst\doc\dataRetrieval.tex LaTeX2e <2011/06/27> Babel <v3.8m> and hyphenation patterns for english, afrikaans, ancientgreek, ar abic, armenian, assamese, basque, bengali, bokmal, bulgarian, catalan, coptic, @@ -384,7 +384,7 @@ LaTeX Font Info: Try loading font information for T1+aer on input line 100. ("C:\Program Files (x86)\MiKTeX 2.9\tex\latex\ae\t1aer.fd" File: t1aer.fd 1997/11/16 Font definitions for T1/aer. )))) -(D:\LADData\RCode\dataRetrieval\master\inst\doc\dataRetrieval.aux) +(D:\LADData\RCode\dataRetrievalGitorious\inst\doc\dataRetrieval.aux) LaTeX Font Info: Checking defaults for OML/cmm/m/it on input line 42. LaTeX Font Info: ... okay on input line 42. LaTeX Font Info: Checking defaults for T1/cmr/m/n on input line 42. @@ -421,8 +421,8 @@ LaTeX Info: Redefining \ref on input line 42. LaTeX Info: Redefining \pageref on input line 42. LaTeX Info: Redefining \nameref on input line 42. -(D:\LADData\RCode\dataRetrieval\master\inst\doc\dataRetrieval.out) -(D:\LADData\RCode\dataRetrieval\master\inst\doc\dataRetrieval.out) +(D:\LADData\RCode\dataRetrievalGitorious\inst\doc\dataRetrieval.out) +(D:\LADData\RCode\dataRetrievalGitorious\inst\doc\dataRetrieval.out) \@outlinefile=\write4 (C:\Users\ldecicco\AppData\Roaming\MiKTeX\2.9\tex\context\base\supp-pdf.mkii @@ -438,8 +438,9 @@ LaTeX Info: Redefining \nameref on input line 42. \MPnumerator=\count123 \makeMPintoPDFobject=\count124 \everyMPtoPDFconversion=\toks21 -) (D:\LADData\RCode\dataRetrieval\master\inst\doc\dataRetrieval-concordance.tex -) (D:\LADData\RCode\dataRetrieval\master\inst\doc\dataRetrieval.toc) +) +(D:\LADData\RCode\dataRetrievalGitorious\inst\doc\dataRetrieval-concordance.tex +) (D:\LADData\RCode\dataRetrievalGitorious\inst\doc\dataRetrieval.toc) \tf@toc=\write5 Overfull \vbox (21.68121pt too high) has occurred while \output is active [] @@ -483,7 +484,7 @@ Overfull \vbox (21.68121pt too high) has occurred while \output is active [] [8] Package atveryend Info: Empty hook `AfterLastShipout' on input line 265. - (D:\LADData\RCode\dataRetrieval\master\inst\doc\dataRetrieval.aux) + (D:\LADData\RCode\dataRetrievalGitorious\inst\doc\dataRetrieval.aux) Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 265. Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 265. Package rerunfilecheck Info: File `dataRetrieval.out' has not changed. @@ -491,7 +492,7 @@ Package rerunfilecheck Info: File `dataRetrieval.out' has not changed. ) Here is how much of TeX's memory you used: 7314 strings out of 494045 - 104581 string characters out of 3145961 + 104611 string characters out of 3145961 185875 words of memory out of 3000000 10453 multiletter control sequences out of 15000+200000 39706 words of font info for 81 fonts, out of 3000000 for 9000 @@ -507,7 +508,7 @@ es (x86)/MiKTeX 2.9/fonts/type1/public/amsfonts/cm/cmr8.pfb><C:/Program Files ( x86)/MiKTeX 2.9/fonts/type1/public/amsfonts/cm/cmsltt10.pfb><C:/Program Files ( x86)/MiKTeX 2.9/fonts/type1/public/amsfonts/cm/cmti10.pfb><C:/Program Files (x8 6)/MiKTeX 2.9/fonts/type1/public/amsfonts/cm/cmtt10.pfb> -Output written on dataRetrieval.pdf (8 pages, 163040 bytes). +Output written on dataRetrieval.pdf (8 pages, 163149 bytes). PDF statistics: 155 PDF objects out of 1000 (max. 8388607) 25 named destinations out of 1000 (max. 500000) diff --git a/inst/doc/dataRetrieval.pdf b/inst/doc/dataRetrieval.pdf index 991c0f887101f2ae4a948b14d00af698efdc90f9..26f94d65157c123e9753d80dc282d9a323255f5e 100644 Binary files a/inst/doc/dataRetrieval.pdf and b/inst/doc/dataRetrieval.pdf differ diff --git a/inst/doc/dataRetrieval.synctex.gz b/inst/doc/dataRetrieval.synctex.gz index 44800ef46cf07c651539fa1fe017fe1b769388a1..5eb48d840aebb1f18ba16e610b06b3c2fffce070 100644 Binary files a/inst/doc/dataRetrieval.synctex.gz and b/inst/doc/dataRetrieval.synctex.gz differ diff --git a/man/dataRetrieval-package.Rd b/man/dataRetrieval-package.Rd index 17b2b6e8667d461592863157abe154092d9edd83..76f6c23e6b860c0b18c541acea48654a1f552f15 100644 --- a/man/dataRetrieval-package.Rd +++ b/man/dataRetrieval-package.Rd @@ -5,8 +5,14 @@ \description{ \tabular{ll}{ Package: \tab dataRetrieval\cr Type: \tab Package\cr Version: \tab 1.0.4\cr Date: \tab - 2012-06-19\cr License: \tab GPL (>= 2)\cr LazyLoad: \tab - yes\cr } + 2012-12-31\cr License: \tab This software is in the + public domain because it contains materials that + originally came from the United States Geological Survey, + an agency of the United States Department of Interior. + For more information, see the official USGS copyright + policy at + http://www.usgs.gov/visual-id/credit_usgs.html#copyright\cr + LazyLoad: \tab yes\cr } } \details{ Collection of functions to help retrieve USGS data from diff --git a/man/getDVData.Rd b/man/getDVData.Rd index a35048ca5147bdd7f2bc37901e75899dfa8c1d07..1af0f45a16f3e4d3bdc81a62efdf2eae33d366af 100644 --- a/man/getDVData.Rd +++ b/man/getDVData.Rd @@ -35,7 +35,7 @@ } \examples{ # These examples require an internet connection to run -getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) +Daily <- getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) } \seealso{ \code{\link{retrieveNWISData}}, diff --git a/man/getMetaData.Rd b/man/getMetaData.Rd index 6edd4a4212c327178dce30a90aede43c0a0b659f..fb57f7d818c177f9756645238dada84569867e04 100644 --- a/man/getMetaData.Rd +++ b/man/getMetaData.Rd @@ -37,7 +37,7 @@ \examples{ # These examples require an internet connection to run # Automatically gets information about site 05114000 and temperature, no interaction with user -getMetaData('05114000','00010',interactive=FALSE) +INFO <- getMetaData('05114000','00010',interactive=FALSE) } \keyword{USGS} \keyword{WRTDS} diff --git a/man/getParameterInfo.Rd b/man/getParameterInfo.Rd index d3dccffd3d253556713eecd4da9a1982d81d47dc..fb9df67602ba06d11c33ae51c97619337e355980 100644 --- a/man/getParameterInfo.Rd +++ b/man/getParameterInfo.Rd @@ -25,8 +25,8 @@ } \examples{ # These examples require an internet connection to run -getParameterInfo('01075') -getParameterInfo('00931',interactive=FALSE) +paramINFO <- getParameterInfo('01075') +paramINFO2 <- getParameterInfo('00931',interactive=FALSE) } \keyword{USGS} \keyword{data} diff --git a/man/getPreLoadedDailyData.Rd b/man/getPreLoadedDailyData.Rd index b3906c03d759db2ad1177319561cc08ea4c0d6ce..8be9941cee8a1e22b9c42a2f1e1783955a01990b 100644 --- a/man/getPreLoadedDailyData.Rd +++ b/man/getPreLoadedDailyData.Rd @@ -26,7 +26,7 @@ data frame. } \examples{ -getPreLoadedDailyData(ChoptankRiverFlow, interactive=FALSE) +Daily <- getPreLoadedDailyData(ChoptankRiverFlow, interactive=FALSE) } \keyword{WRTDS} \keyword{data} diff --git a/man/getPreLoadedData.Rd b/man/getPreLoadedData.Rd index c9cb607218365afc6e4dd02129fa873ff86bcfa8..8236b50a4fd9bb81fed88558e163481312d288b7 100644 --- a/man/getPreLoadedData.Rd +++ b/man/getPreLoadedData.Rd @@ -20,7 +20,7 @@ contains any remark codes. } \examples{ -getPreLoadedData(ChoptankRiverFlow) +rawData <- getPreLoadedData(ChoptankRiverFlow) } \keyword{data} \keyword{import} diff --git a/man/getQWData.Rd b/man/getQWData.Rd index 1f6db6ec2ed04ae9e85816d17ada6cb1ee4ff1d6..395be7e955ca1df5a136f5246896139f66750de0 100644 --- a/man/getQWData.Rd +++ b/man/getQWData.Rd @@ -41,9 +41,9 @@ } \examples{ # These examples require an internet connection to run -getQWData('01594440','01075', '1985-01-01', '1985-03-31') -getQWData('05114000','', '1985-01-01', '1985-03-31') -getQWData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE) +rawSample <- getQWData('01594440','01075', '1985-01-01', '1985-03-31') +rawSampleAll <- getQWData('05114000','', '1985-01-01', '1985-03-31') +rawSampleSelect <- getQWData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE) } \keyword{USGS} \keyword{data} diff --git a/man/getQWDataFromFile.Rd b/man/getQWDataFromFile.Rd index d5a84b99d4205924c972a0e825c68e5d659bdc42..c25fa7a47ff0d1c6805bb7beaaf381de7a0a152a 100644 --- a/man/getQWDataFromFile.Rd +++ b/man/getQWDataFromFile.Rd @@ -31,9 +31,9 @@ \examples{ # Examples of how to use getQWDataFromFile: # Change the file path and file name to something meaningful: -#filePath <- '~/RData/' # Sample format +filePath <- '~/RData/' # Sample format fileName <- 'ChoptankRiverNitrate.csv' -#getQWDataFromFile(filePath,fileName, separator=";") +#rawSampleData <- getQWDataFromFile(filePath,fileName, separator=";") } \keyword{data} \keyword{file} diff --git a/man/getSampleData.Rd b/man/getSampleData.Rd index d374952d2b5ad27461ca2f2d014efcbe972ed8ca..f8fc6db8dd5b2a7f164977fe2e1c287b8eefcb84 100644 --- a/man/getSampleData.Rd +++ b/man/getSampleData.Rd @@ -32,12 +32,15 @@ \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes/} A list of statistic codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} + For raw data, use getQWData. This function will retrieve + the raw data, and compress it (summing constituents). See + chapter 7 of the EGRET user guide for more details. } \examples{ # These examples require an internet connection to run -getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) -getSampleData('05114000','00915;00931', '1985-01-01', '1985-03-31', interactive=FALSE) -getSampleData('05114000','00915;00931', '', '', interactive=FALSE) +Sample_01075 <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) +Sample_All <- getSampleData('05114000','00915;00931', '1985-01-01', '1985-03-31', interactive=FALSE) +Sample_Select <- getSampleData('05114000','00915;00931', '', '', interactive=FALSE) } \seealso{ \code{\link{compressData}}, diff --git a/man/getSampleDataFromFile.Rd b/man/getSampleDataFromFile.Rd index a7a70dc7d22e0f072a9beff34469006cbbfc50c2..f295b54c36bbffe76ecd4934edde2f67b6531f51 100644 --- a/man/getSampleDataFromFile.Rd +++ b/man/getSampleDataFromFile.Rd @@ -31,9 +31,9 @@ \examples{ # Examples of how to use getSampleDataFromFile: # Change the file path and file name to something meaningful: -#filePath <- '~/RData/' # Sample format +filePath <- '~/RData/' # Sample format fileName <- 'ChoptankRiverNitrate.csv' -#getSampleDataFromFile(filePath,fileName, separator=";",interactive=FALSE) +#Sample <- getSampleDataFromFile(filePath,fileName, separator=";",interactive=FALSE) } \keyword{USGS} \keyword{WRTDS} diff --git a/man/getSiteFileData.Rd b/man/getSiteFileData.Rd index 6e7c520cb2515ac639b63e1c54ce41e09edaef71..37a7d14a54aa31799bcb74be2ebf6e8137323eac 100644 --- a/man/getSiteFileData.Rd +++ b/man/getSiteFileData.Rd @@ -22,7 +22,7 @@ } \examples{ # These examples require an internet connection to run -getSiteFileData('05114000',interactive=FALSE) +siteINFO <- getSiteFileData('05114000',interactive=FALSE) } \keyword{USGS} \keyword{data} diff --git a/man/mergeReport.Rd b/man/mergeReport.Rd index 4a1c5688aea14095e67cecd5a7bdfeb1b469c15d..5efff9d3878cddc49ca7a82527a2ece4d08a4f52 100644 --- a/man/mergeReport.Rd +++ b/man/mergeReport.Rd @@ -25,9 +25,9 @@ } \examples{ # These examples require an internet connection to run -exDaily <- getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) -exSample <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) -mergeReport(localDaily = exDaily, localSample = exSample, interactive=FALSE) +Daily <- getDVData('01594440','00060', '1985-01-01', '1985-03-31', interactive=FALSE) +Sample <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE) +Sample <- mergeReport(interactive=FALSE) } \seealso{ \code{\link{getDVData}}, diff --git a/man/populateConcentrations.Rd b/man/populateConcentrations.Rd index 13b7e4d7af32da158b03f8f448317e96383cf238..14b30908b3a1b6f687a8b641c60d9d0a00c87414 100644 --- a/man/populateConcentrations.Rd +++ b/man/populateConcentrations.Rd @@ -19,6 +19,6 @@ code <- c("","<","") value <- c(1,2,3) dataInput <- data.frame(value, code, stringsAsFactors=FALSE) -populateConcentrations(dataInput) +concentrationDF <- populateConcentrations(dataInput) } diff --git a/man/populateDaily.Rd b/man/populateDaily.Rd index b3adf5266d77e785dd2b3e27b3b7f8cd661738ba..5722f563c0cd546c3c1cb92f01026ffb4690c6a3 100644 --- a/man/populateDaily.Rd +++ b/man/populateDaily.Rd @@ -28,7 +28,7 @@ dateTime <- c('1985-01-01', '1985-01-02', '1985-01-03') value <- c(1,2,3) code <- c("","","") dataInput <- data.frame(dateTime, value, code, stringsAsFactors=FALSE) -populateDaily(dataInput, 2, interactive=FALSE) +Daily <- populateDaily(dataInput, 2, interactive=FALSE) } \author{ Robert M. Hirsch \email{rhirsch@usgs.gov} diff --git a/man/populateDateColumns.Rd b/man/populateDateColumns.Rd index 1de8264d87423c363101dc04363c7ca6afe3809d..7473c89d7fa5169c6eae47bdd70916302708d7da 100644 --- a/man/populateDateColumns.Rd +++ b/man/populateDateColumns.Rd @@ -15,6 +15,6 @@ } \examples{ dateTime <- c('1985-01-01', '1985-01-02', '1985-01-03') -populateDateColumns(dateTime) +expandedDateDF <- populateDateColumns(dateTime) } diff --git a/man/populateParameterINFO.Rd b/man/populateParameterINFO.Rd index 56126c57cce5e00e938522136b9a66b8fd0a562c..452eefbe294604f352f12e6a3edf6b1af5fe58c6 100644 --- a/man/populateParameterINFO.Rd +++ b/man/populateParameterINFO.Rd @@ -2,11 +2,12 @@ \alias{populateParameterINFO} \title{Populate Parameter Information Columns} \usage{ - populateParameterINFO(INFO, parameterCd, + populateParameterINFO(parameterCd, localINFO = INFO, interactive = TRUE) } \arguments{ - \item{INFO}{dataframe with value and code columns} + \item{localINFO}{dataframe with value and code columns. + Default is INFO} \item{parameterCd}{string USGS parameter code} @@ -15,7 +16,7 @@ data checks.} } \value{ - INFO dataframe + localINFO dataframe } \description{ Populates INFO data frame with additional user-supplied @@ -23,13 +24,13 @@ } \examples{ #This example requires an internet connection to run -exINFO <- getSiteFileData('01594440') +INFO <- getSiteFileData('01594440') parameterCd <- "00175" parameterData <- getParameterInfo(parameterCd,interactive=interactive) -exINFO$param.nm <- parameterData$parameter_nm -exINFO$param.units <- parameterData$parameter_units -exINFO$paramShortName <- parameterData$srsname -exINFO$paramNumber <- parameterData$parameter_cd -populateParameterINFO(exINFO, parameterCd,interactive=FALSE) +INFO$param.nm <- parameterData$parameter_nm +INFO$param.units <- parameterData$parameter_units +INFO$paramShortName <- parameterData$srsname +INFO$paramNumber <- parameterData$parameter_cd +INFO <- populateParameterINFO(parameterCd,interactive=FALSE) } diff --git a/man/populateSampleColumns.Rd b/man/populateSampleColumns.Rd index a9be6136f5ff6c85cd41554fa4f0b0bc946df500..e7a10161bd6984ec08eac0d989f9470368cd116f 100644 --- a/man/populateSampleColumns.Rd +++ b/man/populateSampleColumns.Rd @@ -21,6 +21,6 @@ ConcLow <- c(1,2,0) ConcHigh <- c(1,2,3) Uncen <- c(1,1,0) dataInput <- data.frame(dateTime, ConcLow, ConcHigh, Uncen, stringsAsFactors=FALSE) -populateSampleColumns(dataInput) +Sample <- populateSampleColumns(dataInput) } diff --git a/man/populateSiteINFO.Rd b/man/populateSiteINFO.Rd index 8d96f7e766c1e1c90dc9f19f61b9e448e677906a..7603aa9645780c95fe4ed5b4983f8c9964f4722c 100644 --- a/man/populateSiteINFO.Rd +++ b/man/populateSiteINFO.Rd @@ -23,8 +23,8 @@ } \examples{ #This example requires an internet connection to run -exINFO <- getSiteFileData('01594440') +INFO <- getSiteFileData('01594440') siteNumber <- "01594440" -populateSiteINFO(exINFO, siteNumber,interactive=FALSE) +siteINFO <- populateSiteINFO(INFO, siteNumber,interactive=FALSE) } diff --git a/man/retrieveNWISData.Rd b/man/retrieveNWISData.Rd index 5bb61a10e8b63632db0e5767f9e0193629882f44..ae1547e621824f26cf30b3cdd912228a8d394d5f 100644 --- a/man/retrieveNWISData.Rd +++ b/man/retrieveNWISData.Rd @@ -39,8 +39,8 @@ } \examples{ # These examples require an internet connection to run -retrieveNWISData('01594440','00060', '1985-01-01', '1985-01-31') -retrieveNWISData('05114000','00010', '1985-01-01', '1985-01-31', StatCd='00001',interactive=FALSE) +rawDailyFlowData <- retrieveNWISData('01594440','00060', '1985-01-01', '1985-01-31') +rawDailyTemperatureData <- retrieveNWISData('05114000','00010', '1985-01-01', '1985-01-31', StatCd='00001',interactive=FALSE) } \keyword{USGS} \keyword{data} diff --git a/man/retrieveUnitNWISData.Rd b/man/retrieveUnitNWISData.Rd index a555593f53bf8b0bf27d58bd1184d083e37511e7..79001197a49c9f311308ed7f1c1d3ed66933720b 100644 --- a/man/retrieveUnitNWISData.Rd +++ b/man/retrieveUnitNWISData.Rd @@ -26,8 +26,8 @@ data checks.} } \value{ - retval dataframe with agency, site, dateTime, value, and - code columns + retval dataframe with agency, site, dateTime, time zone, + value, and code columns } \description{ Imports data from NWIS web service. This function gets @@ -43,7 +43,7 @@ ParameterCd <- '00060' StartDate <- '2012-05-01' EndDate <- '2012-05-02' # These examples require an internet connection to run -retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE) +rawData <- retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE) } \keyword{USGS} \keyword{data}