diff --git a/DESCRIPTION b/DESCRIPTION index cfe223e45a02fb21ddc6af58aa5279f406929924..601e0cf08f67778de2c684b903b28eed895681dc 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -28,3 +28,44 @@ Suggests: LazyLoad: yes LazyData: yes VignetteBuilder: knitr +Collate: + 'checkStartEndDate.r' + 'compressData.r' + 'constructNWISURL.r' + 'dataOverview.r' + 'dateFormatCheck.r' + 'formatCheckDate.r' + 'formatCheckParameterCd.r' + 'formatCheckSiteNumber.r' + 'getDVData.r' + 'getDailyDataFromFile.r' + 'getDataAvailability.r' + 'getDataFromFile.r' + 'getMetaData.r' + 'getParameterInfo.r' + 'getQWData.r' + 'getQWDataFromFile.r' + 'getRDB1Data.r' + 'getRawQWData.r' + 'getSTORETSampleData.R' + 'getSampleData.r' + 'getSampleDataFromFile.r' + 'getSiteFileData.r' + 'getWQPData.r' + 'getWaterML1Data.r' + 'getWaterML2Data.r' + 'mergeReport.r' + 'padVariable.r' + 'populateConcentrations.r' + 'populateDaily.r' + 'populateDateColumns.r' + 'populateParameterINFO.r' + 'populateSampleColumns.r' + 'populateSiteINFO.r' + 'processQWData.r' + 'removeDuplicates.r' + 'renameColumns.R' + 'retrieveNWISData.r' + 'retrieveNWISqwData.r' + 'retrieveUnitNWISData.r' + 'tabbedDataRetrievals.R' diff --git a/man/ChoptankRiverFlow.Rd b/man/ChoptankRiverFlow.Rd index 8bfe9ca2847a9d43687748b43cf47cd68f45917f..e3220cb26ec899e18cb50eb3f1fc2dac85c74705 100644 --- a/man/ChoptankRiverFlow.Rd +++ b/man/ChoptankRiverFlow.Rd @@ -3,13 +3,14 @@ \alias{ChoptankRiverFlow} \title{Example Streamflow Data included in dataRetrieval} \description{ -Example data representing Streamflow and Nitrate from the -Choptank River at Greensboro, MD, USGS data + Example data representing Streamflow and Nitrate from the + Choptank River at Greensboro, MD, USGS data } \author{ -Robert M. Hirsch \email{rhirsch@usgs.gov} + Robert M. Hirsch \email{rhirsch@usgs.gov} } \keyword{data} +\keyword{datasets} \keyword{flow} \keyword{water} diff --git a/man/ChoptankRiverNitrate.Rd b/man/ChoptankRiverNitrate.Rd index e7bff34301ca6d82fa07770002820a8307349788..435899d342946191abe385cedfaadce4fe6ff37e 100644 --- a/man/ChoptankRiverNitrate.Rd +++ b/man/ChoptankRiverNitrate.Rd @@ -3,15 +3,16 @@ \alias{ChoptankRiverNitrate} \title{Example Water Quality Data included in dataRetrieval} \description{ -Example data representing Nitrate from the Choptank River -at Greensboro, MD, USGS data -\if{html}{\figure{Chop1.png}{Example Data}} -\if{latex}{\figure{Chop1.png}} + Example data representing Nitrate from the Choptank River + at Greensboro, MD, USGS data + \if{html}{\figure{Chop1.png}{Example Data}} + \if{latex}{\figure{Chop1.png}} } \author{ -Robert M. Hirsch \email{rhirsch@usgs.gov} + Robert M. Hirsch \email{rhirsch@usgs.gov} } \keyword{data} +\keyword{datasets} \keyword{quality} \keyword{water} diff --git a/man/checkStartEndDate.Rd b/man/checkStartEndDate.Rd index 79b0c57ba60a51b825923a6994a1b1c6aaadcca7..ce5da41b9ff354cc6a75844912f837221ac37adb 100644 --- a/man/checkStartEndDate.Rd +++ b/man/checkStartEndDate.Rd @@ -2,7 +2,7 @@ \alias{checkStartEndDate} \title{checkStartEndDate} \usage{ -checkStartEndDate(StartDate, EndDate, interactive = TRUE) + checkStartEndDate(StartDate, EndDate, interactive = TRUE) } \arguments{ \item{StartDate}{string} @@ -14,12 +14,12 @@ checkStartEndDate(StartDate, EndDate, interactive = TRUE) data checks.} } \value{ -vector where first value is StartDate, second is EndDate + vector where first value is StartDate, second is EndDate } \description{ -Checks that the start date is before the end date. If not, -it will give the user the opportunity to correct, otherwise -will create a warning. + Checks that the start date is before the end date. If + not, it will give the user the opportunity to correct, + otherwise will create a warning. } \examples{ startDate <- '1985-01-01' diff --git a/man/compressData.Rd b/man/compressData.Rd index 610716850da2e9247f02abd1390b5779d16cccc2..143dbcc72c6db7959e9542ad30dd7800b2b225ab 100644 --- a/man/compressData.Rd +++ b/man/compressData.Rd @@ -2,7 +2,7 @@ \alias{compressData} \title{Compress sample data frame} \usage{ -compressData(data, interactive = TRUE) + compressData(data, interactive = TRUE) } \arguments{ \item{data}{dataframe contains at least dateTime, value, @@ -13,17 +13,17 @@ compressData(data, interactive = TRUE) data checks.} } \value{ -dataframe returnDataFrame data frame containing dateTime, -ConcHigh, ConcLow, Uncen, ConcAve + dataframe returnDataFrame data frame containing dateTime, + ConcHigh, ConcLow, Uncen, ConcAve } \description{ -Using raw data that has at least dateTime, value, code, -populates the measured data portion of the Sample data -frame used in WRTDS ConcLow = Lower bound for an observed -concentration ConcHigh = Upper bound for an observed -concentration ConcAve = Average of ConcLow and ConcHigh. -If ConcLow is NA, then ConcAve = ConcHigh/2 Uncen = 1 if -uncensored, 0 if censored + Using raw data that has at least dateTime, value, code, + populates the measured data portion of the Sample data + frame used in WRTDS ConcLow = Lower bound for an observed + concentration ConcHigh = Upper bound for an observed + concentration ConcAve = Average of ConcLow and ConcHigh. + If ConcLow is NA, then ConcAve = ConcHigh/2 Uncen = 1 if + uncensored, 0 if censored } \examples{ dateTime <- c('1985-01-01', '1985-01-02', '1985-01-03') diff --git a/man/constructNWISURL.Rd b/man/constructNWISURL.Rd index 981b295f1a43cc1d44dbdc30cf9edcd1c1e57137..cb175606852aba1357fa2c1e1963f8c47cb04812 100644 --- a/man/constructNWISURL.Rd +++ b/man/constructNWISURL.Rd @@ -2,9 +2,9 @@ \alias{constructNWISURL} \title{Construct NWIS url for data retrieval} \usage{ -constructNWISURL(siteNumber, parameterCd, startDate, endDate, service, - statCd = "00003", format = "xml", expanded = FALSE, - interactive = TRUE) + constructNWISURL(siteNumber, parameterCd, startDate, + endDate, service, statCd = "00003", format = "xml", + expanded = FALSE, interactive = TRUE) } \arguments{ \item{siteNumber}{string or vector of strings USGS site @@ -48,16 +48,16 @@ constructNWISURL(siteNumber, parameterCd, startDate, endDate, service, data checks.} } \value{ -url string + url string } \description{ -Imports data from NWIS web service. This function gets the -data from here: -\url{http://nwis.waterdata.usgs.gov/nwis/qwdata} 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} + Imports data from NWIS web service. This function gets + the data from here: + \url{http://nwis.waterdata.usgs.gov/nwis/qwdata} 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} } \examples{ siteNumber <- '01594440' diff --git a/man/dataOverview.Rd b/man/dataOverview.Rd index 740a0591aee69a7e14ec3e27a316fbe36e299ac2..6fe56a3ac2930bf546840bcbdb75fea354dadd3f 100644 --- a/man/dataOverview.Rd +++ b/man/dataOverview.Rd @@ -2,7 +2,7 @@ \alias{dataOverview} \title{Data Overview for WRTDS} \usage{ -dataOverview(localDaily = Daily, localSample = Sample) + dataOverview(localDaily = Daily, localSample = Sample) } \arguments{ \item{localDaily}{dataframe} @@ -10,7 +10,7 @@ dataOverview(localDaily = Daily, localSample = Sample) \item{localSample}{dataframe} } \description{ -Gives a summary of data to be used for WRTDS analysis + Gives a summary of data to be used for WRTDS analysis } \examples{ # These examples require an internet connection to run @@ -19,7 +19,7 @@ exSample <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31', intera dataOverview(localDaily = exDaily, localSample = exSample) } \seealso{ -\code{\link{mergeReport}} + \code{\link{mergeReport}} } \keyword{USGS} \keyword{WRTDS} diff --git a/man/dataRetrieval-package.Rd b/man/dataRetrieval-package.Rd index ea978468281dbd65d3b6249d20785356ecb06e7e..055aa874443eceef6efd9efdc9fce3983d7e5c5a 100644 --- a/man/dataRetrieval-package.Rd +++ b/man/dataRetrieval-package.Rd @@ -3,33 +3,33 @@ \alias{dataRetrieval-package} \title{Retrieval functions for USGS data} \description{ -\tabular{ll}{ Package: \tab dataRetrieval\cr Type: \tab -Package\cr Version: \tab 1.2.1\cr Date: \tab 2012-12-31\cr -License: \tab Unlimited for this package, dependencies have -more restrictive licensing.\cr Copyright: \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 } + \tabular{ll}{ Package: \tab dataRetrieval\cr Type: \tab + Package\cr Version: \tab 1.2.1\cr Date: \tab + 2012-12-31\cr License: \tab Unlimited for this package, + dependencies have more restrictive licensing.\cr + Copyright: \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 -either web services or user provided data files. + Collection of functions to help retrieve USGS data from + either web services or user provided data files. } \author{ -Robert M. Hirsch \email{rhirsch@usgs.gov}, Laura De Cicco -\email{ldecicco@usgs.gov} + Robert M. Hirsch \email{rhirsch@usgs.gov}, Laura De Cicco + \email{ldecicco@usgs.gov} } \references{ -Hirsch, R. M., Moyer, D. L. and Archfield, S. A. (2010), -Weighted Regressions on Time, Discharge, and Season -(WRTDS), with an Application to Chesapeake Bay River -Inputs. JAWRA Journal of the American Water Resources -Association, 46: 857-880. doi: -10.1111/j.1752-1688.2010.00482.x + Hirsch, R. M., Moyer, D. L. and Archfield, S. A. (2010), + Weighted Regressions on Time, Discharge, and Season + (WRTDS), with an Application to Chesapeake Bay River + Inputs. JAWRA Journal of the American Water Resources + Association, 46: 857-880. doi: + 10.1111/j.1752-1688.2010.00482.x } \keyword{data,} \keyword{retrieval} diff --git a/man/dateFormatCheck.Rd b/man/dateFormatCheck.Rd index c27c908fb22619e02e1277fa7688d9b2f24eee25..dd75fee619a69001adad54bba538e9d5980ee496 100644 --- a/man/dateFormatCheck.Rd +++ b/man/dateFormatCheck.Rd @@ -2,17 +2,17 @@ \alias{dateFormatCheck} \title{dateFormatCheck} \usage{ -dateFormatCheck(date) + dateFormatCheck(date) } \arguments{ \item{date}{string} } \value{ -condition logical if TRUE, + condition logical if TRUE, } \description{ -Checks to see if format is YYYY-MM-DD. Also performs a few -other date checks. + Checks to see if format is YYYY-MM-DD. Also performs a + few other date checks. } \examples{ date <- '1985-01-01' diff --git a/man/formatCheckDate.Rd b/man/formatCheckDate.Rd index eaca3155e5c6aa3c4bf67c1564e95e2fb8ee4ed1..64c54b65061785ecf5741d3f1c4eac8c9ac3af0d 100644 --- a/man/formatCheckDate.Rd +++ b/man/formatCheckDate.Rd @@ -2,7 +2,7 @@ \alias{formatCheckDate} \title{formatCheckDate} \usage{ -formatCheckDate(Date, dateString, interactive = TRUE) + formatCheckDate(Date, dateString, interactive = TRUE) } \arguments{ \item{Date}{string} @@ -15,12 +15,12 @@ formatCheckDate(Date, dateString, interactive = TRUE) data checks.} } \value{ -condition logical if TRUE, + condition logical if TRUE, } \description{ -Response to the date format checker. If the date is not -formated correctly, it will give the user the opportunity -to correct, otherwise will create a warning. + Response to the date format checker. If the date is not + formated correctly, it will give the user the opportunity + to correct, otherwise will create a warning. } \examples{ Date <- '1985-01-01' diff --git a/man/formatCheckParameterCd.Rd b/man/formatCheckParameterCd.Rd index 416b9dbaf73b4508e727439c8877c5d64b6cc126..a506bd85e0ba4eda3d47c926635ed44c98a33fb8 100644 --- a/man/formatCheckParameterCd.Rd +++ b/man/formatCheckParameterCd.Rd @@ -2,7 +2,7 @@ \alias{formatCheckParameterCd} \title{formatCheckParameterCd} \usage{ -formatCheckParameterCd(ParameterCd, interactive = TRUE) + formatCheckParameterCd(ParameterCd, interactive = TRUE) } \arguments{ \item{ParameterCd}{string to check} @@ -12,12 +12,12 @@ formatCheckParameterCd(ParameterCd, interactive = TRUE) data checks.} } \value{ -ParameterCd string + ParameterCd string } \description{ -Checks that the parameter code is 5 digits. If it is less, -it will pad the string with zeros. If more, ask the user to -re-enter. + Checks that the parameter code is 5 digits. If it is + less, it will pad the string with zeros. If more, ask the + user to re-enter. } \examples{ pCode <- '01234' diff --git a/man/formatCheckSiteNumber.Rd b/man/formatCheckSiteNumber.Rd index fabd0d594e646a9953c069bd20958cfdca8d639b..a425ff1dd535c701ae905a9973a878307cc0c6f3 100644 --- a/man/formatCheckSiteNumber.Rd +++ b/man/formatCheckSiteNumber.Rd @@ -2,7 +2,7 @@ \alias{formatCheckSiteNumber} \title{formatCheckSiteNumber} \usage{ -formatCheckSiteNumber(siteNumber, interactive = TRUE) + formatCheckSiteNumber(siteNumber, interactive = TRUE) } \arguments{ \item{siteNumber}{string to check} @@ -12,11 +12,11 @@ formatCheckSiteNumber(siteNumber, interactive = TRUE) data checks.} } \value{ -siteNumber string + siteNumber string } \description{ -Checks that the site code is at least 8 digits. If not, it -confirms with the user. + Checks that the site code is at least 8 digits. If not, + it confirms with the user. } \examples{ site<- '01234567' diff --git a/man/getDVData.Rd b/man/getDVData.Rd index e4e5e188261b387317b45bfc3da9e4f312bf613b..ecb58f4f9f3b6c61af010e3f3be8ed740efd8d0a 100644 --- a/man/getDVData.Rd +++ b/man/getDVData.Rd @@ -2,8 +2,8 @@ \alias{getDVData} \title{Import Daily Data for WRTDS} \usage{ -getDVData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE, - convert = TRUE, format = "tsv") + getDVData(siteNumber, ParameterCd, StartDate, EndDate, + interactive = TRUE, convert = TRUE, format = "tsv") } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -41,15 +41,15 @@ getDVData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE, expected. The default is "tsv".} } \value{ -Daily dataframe + Daily dataframe } \description{ -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/} A list -of statistic codes can be found here: -\url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} + 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/} A list + of statistic codes can be found here: + \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} } \examples{ # These examples require an internet connection to run @@ -58,7 +58,8 @@ DailyCFS <- getDVData('01594440','00060', '1985-01-01', '1985-03-31',convert=FAL DailySuspSediment <- getDVData('01594440','80154', '1985-01-01', '1985-03-31') } \seealso{ -\code{\link{retrieveNWISData}}, \code{\link{populateDaily}} + \code{\link{retrieveNWISData}}, + \code{\link{populateDaily}} } \keyword{USGS} \keyword{WRTDS} diff --git a/man/getDailyDataFromFile.Rd b/man/getDailyDataFromFile.Rd index 6b72f9a4c63caea9c127e7a8867a52f603fd0892..da0b77309f7cbe933607a0be944e38193d240155 100644 --- a/man/getDailyDataFromFile.Rd +++ b/man/getDailyDataFromFile.Rd @@ -2,8 +2,9 @@ \alias{getDailyDataFromFile} \title{Import Daily Data for WRTDS} \usage{ -getDailyDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",", - qUnit = 1, interactive = TRUE) + getDailyDataFromFile(filePath, fileName, + hasHeader = TRUE, separator = ",", qUnit = 1, + interactive = TRUE) } \arguments{ \item{filePath}{string specifying the path to the file} @@ -25,11 +26,12 @@ getDailyDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",", data checks.} } \value{ -Daily dataframe + Daily dataframe } \description{ -Imports data from a user-supplied file, and converts it to -a Daily data frame, appropriate for WRTDS calculations. + Imports data from a user-supplied file, and converts it + to a Daily data frame, appropriate for WRTDS + calculations. } \examples{ filePath <- system.file("extdata", package="dataRetrieval") diff --git a/man/getDataAvailability.Rd b/man/getDataAvailability.Rd index db1119da6c0ad8626c6b171f1470681dbf4be8dc..29f79bc3de6cb6b8da103aa493be93de13b5eeaa 100644 --- a/man/getDataAvailability.Rd +++ b/man/getDataAvailability.Rd @@ -2,7 +2,7 @@ \alias{getDataAvailability} \title{USGS data availability} \usage{ -getDataAvailability(siteNumber, interactive = TRUE) + getDataAvailability(siteNumber, interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -12,14 +12,14 @@ getDataAvailability(siteNumber, interactive = TRUE) If true, a progress indicator is printed to the console.} } \value{ -retval dataframe with all information found in the expanded -site file + retval dataframe with all information found in the + expanded site file } \description{ -Imports a table of available parameters, period of record, -and count. There is also an option to load the long -parameter names and additional information on the -parameters with longNames=TRUE. + Imports a table of available parameters, period of + record, and count. There is also an option to load the + long parameter names and additional information on the + parameters with longNames=TRUE. } \examples{ # These examples require an internet connection to run diff --git a/man/getDataFromFile.Rd b/man/getDataFromFile.Rd index b26f16cee665c95983814edab53eef8a375f3ab3..3e07f6f1b190add53c99317891a7730efc274809 100644 --- a/man/getDataFromFile.Rd +++ b/man/getDataFromFile.Rd @@ -2,7 +2,8 @@ \alias{getDataFromFile} \title{Basic Data Import for Water Flow Data} \usage{ -getDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",") + getDataFromFile(filePath, fileName, hasHeader = TRUE, + separator = ",") } \arguments{ \item{filePath}{string specifying the path to the file} @@ -16,14 +17,14 @@ getDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",") cells} } \value{ -retval dataframe with dateTime, value, and code columns + retval dataframe with dateTime, value, and code columns } \description{ -Imports data from user-supplied data file. Specifically -used to import water flow data for use in the WRTDS -package. For WRTDS usage, the first column is expected to -be dates, the second column measured values. The third -column is optional, it contains any remark codes. + Imports data from user-supplied data file. Specifically + used to import water flow data for use in the WRTDS + package. For WRTDS usage, the first column is expected to + be dates, the second column measured values. The third + column is optional, it contains any remark codes. } \examples{ # Examples of how to use getDataFromFile: diff --git a/man/getMetaData.Rd b/man/getMetaData.Rd index 74d12b932f23983320e81ba8fd338efd9e6a56b4..91ae02d37af2334be85e06624148abed504efe14 100644 --- a/man/getMetaData.Rd +++ b/man/getMetaData.Rd @@ -2,7 +2,8 @@ \alias{getMetaData} \title{Import Metadata for USGS Data} \usage{ -getMetaData(siteNumber = "", parameterCd = "", interactive = TRUE) + getMetaData(siteNumber = "", parameterCd = "", + interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -16,22 +17,22 @@ getMetaData(siteNumber = "", parameterCd = "", interactive = TRUE) data checks.} } \value{ -INFO dataframe with agency, site, dateTime, value, and code -columns + INFO dataframe with agency, site, dateTime, value, and + code columns } \description{ -Populates INFO data frame for WRTDS study. If either -station number or parameter code supplied, imports data -about a particular USGS site 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/} If -either station number or parameter code is not supplied, -the user will be asked to input data. Additionally, the -user will be asked for: staAbbrev - station abbreviation, -will be used in naming output files and for structuring -batch jobs constitAbbrev - constitute abbreviation + Populates INFO data frame for WRTDS study. If either + station number or parameter code supplied, imports data + about a particular USGS site 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/} If + either station number or parameter code is not supplied, + the user will be asked to input data. Additionally, the + user will be asked for: staAbbrev - station abbreviation, + will be used in naming output files and for structuring + batch jobs constitAbbrev - constitute abbreviation } \examples{ # These examples require an internet connection to run diff --git a/man/getParameterInfo.Rd b/man/getParameterInfo.Rd index 004b6fd27bc4736a0139514318e0797a57dec443..2cfa2d1cad594c411b0ad17dde28ecb881046a1b 100644 --- a/man/getParameterInfo.Rd +++ b/man/getParameterInfo.Rd @@ -2,7 +2,7 @@ \alias{getParameterInfo} \title{USGS Parameter Data Retrieval} \usage{ -getParameterInfo(parameterCd, interactive = TRUE) + getParameterInfo(parameterCd, interactive = TRUE) } \arguments{ \item{parameterCd}{vector of USGS parameter codes. This @@ -13,15 +13,15 @@ getParameterInfo(parameterCd, interactive = TRUE) data checks.} } \value{ -parameterData dataframe with all information from the USGS -about the particular parameter (usually code, name, short -name, units, and CAS registry numbers) + parameterData dataframe with all information from the + USGS about the particular parameter (usually code, name, + short name, units, and CAS registry numbers) } \description{ -Imports data from NWIS about meaured parameter based on -user-supplied parameter code. This function gets the data -from here: -\url{http://nwis.waterdata.usgs.gov/nwis/pmcodes} + Imports data from NWIS about meaured parameter based on + user-supplied parameter code. This function gets the data + from here: + \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes} } \examples{ # These examples require an internet connection to run diff --git a/man/getQWData.Rd b/man/getQWData.Rd index eb2d7f3745b0c5653b43b05b6fb2e81500d90536..70f7885ccba58ef2dd0f5a29dcd5e4d5f2481bbf 100644 --- a/man/getQWData.Rd +++ b/man/getQWData.Rd @@ -2,7 +2,8 @@ \alias{getQWData} \title{Data Import for USGS NWIS Water Quality Data} \usage{ -getQWData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE) + getQWData(siteNumber, ParameterCd, StartDate, EndDate, + interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -25,19 +26,19 @@ getQWData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE) data checks.} } \value{ -retval dataframe with first column dateTime, and at least -one qualifier and value columns (subsequent qualifier/value -columns could follow depending on requested parameter -codes) + retval dataframe with first column dateTime, and at least + one qualifier and value columns (subsequent + qualifier/value columns could follow depending on + requested parameter codes) } \description{ -Imports and processes data from NWIS web service. This -function gets the data from here: -\url{http://www.waterqualitydata.us} 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} + Imports and processes data from NWIS web service. This + function gets the data from here: + \url{http://www.waterqualitydata.us} 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} } \examples{ # These examples require an internet connection to run diff --git a/man/getQWDataFromFile.Rd b/man/getQWDataFromFile.Rd index 2822df05424b36257a448fd9190fd35b89688588..1303449e53bd8b0d45a379c661ae17f392bf6d38 100644 --- a/man/getQWDataFromFile.Rd +++ b/man/getQWDataFromFile.Rd @@ -2,7 +2,8 @@ \alias{getQWDataFromFile} \title{Basic Data Import} \usage{ -getQWDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",") + getQWDataFromFile(filePath, fileName, hasHeader = TRUE, + separator = ",") } \arguments{ \item{filePath}{string specifying the path to the file} @@ -16,16 +17,16 @@ getQWDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",") cells} } \value{ -retval dataframe + retval dataframe } \description{ -Imports data from user-supplied data file. Specifically -used to import water quality data for use in the WRTDS -package. For WRTDS usage, the first column is expected to -be dates, the second column remarks (specifically < if -censored data), and the third column is measured values. -There can be additional columns of data, for each column of -data, there should be a remark column preceeding. + Imports data from user-supplied data file. Specifically + used to import water quality data for use in the WRTDS + package. For WRTDS usage, the first column is expected to + be dates, the second column remarks (specifically < if + censored data), and the third column is measured values. + There can be additional columns of data, for each column + of data, there should be a remark column preceeding. } \examples{ # Examples of how to use getQWDataFromFile: diff --git a/man/getRDB1Data.Rd b/man/getRDB1Data.Rd index f272321bbcc1bbbf2ecbf961a1cb6c2405cb32b7..6777c95a5b7ebe752f727a1f2b0244d9aee59aab 100644 --- a/man/getRDB1Data.Rd +++ b/man/getRDB1Data.Rd @@ -2,7 +2,7 @@ \alias{getRDB1Data} \title{Function to return data from the NWIS RDB 1.0 format} \usage{ -getRDB1Data(obs_url, asDateTime = FALSE) + getRDB1Data(obs_url, asDateTime = FALSE) } \arguments{ \item{obs_url}{string containing the url for the @@ -12,14 +12,14 @@ getRDB1Data(obs_url, asDateTime = FALSE) as POSIXct, if FALSE, Date} } \value{ -data a data frame containing columns agency, site, -dateTime, values, and remark codes for all requested -combinations + data a data frame containing columns agency, site, + dateTime, values, and remark codes for all requested + combinations } \description{ -This function accepts a url parameter that already contains -the desired NWIS site, parameter code, statistic, startdate -and enddate. + This function accepts a url parameter that already + contains the desired NWIS site, parameter code, + statistic, startdate and enddate. } \examples{ sites <- "02177000" diff --git a/man/getRawQWData.Rd b/man/getRawQWData.Rd index 585aa3635dcf7502ef2aab3c3224e21daf89c2e3..b1aaccf3f4ba98c5ba10aa23757614e4391ceb92 100644 --- a/man/getRawQWData.Rd +++ b/man/getRawQWData.Rd @@ -2,7 +2,8 @@ \alias{getRawQWData} \title{Raw Data Import for USGS NWIS Water Quality Data} \usage{ -getRawQWData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE) + getRawQWData(siteNumber, ParameterCd, StartDate, EndDate, + interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -23,18 +24,18 @@ getRawQWData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE) data checks.} } \value{ -retval dataframe with first column dateTime, and at least -one qualifier and value columns (subsequent qualifier/value -columns could follow depending on requested parameter -codes) + retval dataframe with first column dateTime, and at least + one qualifier and value columns (subsequent + qualifier/value columns could follow depending on + requested parameter codes) } \description{ -Imports data from NWIS web service. This function gets the -data from here: \url{http://www.waterqualitydata.us} 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} + Imports data from NWIS web service. This function gets + the data from here: \url{http://www.waterqualitydata.us} + 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} } \examples{ # These examples require an internet connection to run diff --git a/man/getSTORETSampleData.Rd b/man/getSTORETSampleData.Rd index 80ddabea2676f3f7e50c37e39b86450a53baca1a..5fe9a4d79738ad6db7a43422ef8e43a398527567 100644 --- a/man/getSTORETSampleData.Rd +++ b/man/getSTORETSampleData.Rd @@ -2,8 +2,8 @@ \alias{getSTORETSampleData} \title{Import Sample Data for WRTDS} \usage{ -getSTORETSampleData(siteNumber, characteristicName, StartDate, EndDate, - interactive = TRUE) + getSTORETSampleData(siteNumber, characteristicName, + StartDate, EndDate, interactive = TRUE) } \arguments{ \item{siteNumber}{string site number. If USGS, it should @@ -22,18 +22,18 @@ getSTORETSampleData(siteNumber, characteristicName, StartDate, EndDate, data checks.} } \value{ -Sample dataframe + Sample dataframe } \description{ -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. + 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. } \examples{ # These examples require an internet connection to run @@ -41,8 +41,8 @@ Sample_01075 <- getSTORETSampleData('USGS-01594440','Chloride', '', '') Sample_All <- getSTORETSampleData('WIDNR_WQX-10032762','Specific conductance', '', '') } \seealso{ -\code{\link{compressData}}, -\code{\link{populateSampleColumns}} + \code{\link{compressData}}, + \code{\link{populateSampleColumns}} } \keyword{USGS} \keyword{WRTDS} diff --git a/man/getSampleData.Rd b/man/getSampleData.Rd index a51361c63a3ab4e14a04ad48e8fa9c98c061213d..51fa28ff1bfdfa33f6b2a1b347002e4153e8dd5d 100644 --- a/man/getSampleData.Rd +++ b/man/getSampleData.Rd @@ -2,7 +2,8 @@ \alias{getSampleData} \title{Import Sample Data for WRTDS} \usage{ -getSampleData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE) + getSampleData(siteNumber, ParameterCd, StartDate, + EndDate, interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -22,19 +23,19 @@ getSampleData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE) data checks.} } \value{ -Sample dataframe + Sample dataframe } \description{ -Imports data from NWIS web service. This function gets the -data from here: -\url{http://nwis.waterdata.usgs.gov/nwis/qwdata/} 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 -section 3.4 of the vignette for more details. + Imports data from NWIS web service. This function gets + the data from here: + \url{http://nwis.waterdata.usgs.gov/nwis/qwdata/} 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 + section 3.4 of the vignette for more details. } \examples{ # These examples require an internet connection to run @@ -43,8 +44,8 @@ Sample_All <- getSampleData('05114000','00915;00931', '1985-01-01', '1985-03-31' Sample_Select <- getSampleData('05114000','00915;00931', '', '') } \seealso{ -\code{\link{compressData}}, -\code{\link{populateSampleColumns}} + \code{\link{compressData}}, + \code{\link{populateSampleColumns}} } \keyword{USGS} \keyword{WRTDS} diff --git a/man/getSampleDataFromFile.Rd b/man/getSampleDataFromFile.Rd index 07b6008013864640e9a32e236c84f49c08a9c356..dde62ca6ecedc31e650531bb26f7a2c95a94e66c 100644 --- a/man/getSampleDataFromFile.Rd +++ b/man/getSampleDataFromFile.Rd @@ -2,8 +2,8 @@ \alias{getSampleDataFromFile} \title{Import Sample Data for WRTDS} \usage{ -getSampleDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",", - interactive = TRUE) + getSampleDataFromFile(filePath, fileName, + hasHeader = TRUE, separator = ",", interactive = TRUE) } \arguments{ \item{filePath}{string specifying the path to the file} @@ -21,13 +21,13 @@ getSampleDataFromFile(filePath, fileName, hasHeader = TRUE, separator = ",", data checks.} } \value{ -Sample dataframe + Sample dataframe } \description{ -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. + 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. } \examples{ filePath <- system.file("extdata", package="dataRetrieval") diff --git a/man/getSiteFileData.Rd b/man/getSiteFileData.Rd index c71037b80492153e6bbfc08f223f56d13df77072..56f3fdff84903dc5f704b46179269f3660fb5867 100644 --- a/man/getSiteFileData.Rd +++ b/man/getSiteFileData.Rd @@ -2,7 +2,7 @@ \alias{getSiteFileData} \title{USGS Site File Data Retrieval} \usage{ -getSiteFileData(siteNumber = "", interactive = TRUE) + getSiteFileData(siteNumber = "", interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -13,12 +13,12 @@ getSiteFileData(siteNumber = "", interactive = TRUE) data checks.} } \value{ -retval dataframe with all information found in the expanded -site file + retval dataframe with all information found in the + expanded site file } \description{ -Imports data from USGS site file site. This function gets -data from here: \url{http://waterservices.usgs.gov/} + Imports data from USGS site file site. This function gets + data from here: \url{http://waterservices.usgs.gov/} } \examples{ # These examples require an internet connection to run diff --git a/man/getWQPData.Rd b/man/getWQPData.Rd index 4ae5b2b914b749a76fbdf5476f162799333ddeaa..a3b275d477aa664bc684d798eb3b33d64ddcf9f5 100644 --- a/man/getWQPData.Rd +++ b/man/getWQPData.Rd @@ -2,8 +2,8 @@ \alias{getWQPData} \title{Data Import from Water Quality Portal} \usage{ -getWQPData(siteNumber, characteristicName, StartDate, EndDate, - interactive = TRUE) + getWQPData(siteNumber, characteristicName, StartDate, + EndDate, interactive = TRUE) } \arguments{ \item{siteNumber}{string site number. If USGS, it should @@ -22,20 +22,21 @@ getWQPData(siteNumber, characteristicName, StartDate, EndDate, data checks.} } \value{ -retval dataframe with first column dateTime, and at least -one qualifier and value columns (subsequent qualifier/value -columns could follow depending on requested parameter -codes) + retval dataframe with first column dateTime, and at least + one qualifier and value columns (subsequent + qualifier/value columns could follow depending on + requested parameter codes) } \description{ -Imports data from Water Quality Portal web service. This -function gets the data from here: -\url{http://www.waterqualitydata.us}. This function is more -general than getQWData because it allows for other agencies -rather than the USGS. Therefore, the 5-digit parameter -code cannot be used. Instead, this function uses -characteristicName. A complete list can be found here -\url{http://www.waterqualitydata.us/Codes/Characteristicname} + Imports data from Water Quality Portal web service. This + function gets the data from here: + \url{http://www.waterqualitydata.us}. This function is + more general than getQWData because it allows for other + agencies rather than the USGS. Therefore, the 5-digit + parameter code cannot be used. Instead, this function + uses characteristicName. A complete list can be found + here + \url{http://www.waterqualitydata.us/Codes/Characteristicname} } \examples{ # These examples require an internet connection to run diff --git a/man/getWaterML1Data.Rd b/man/getWaterML1Data.Rd index ffedec547bf6235307a07e88704d5048c1a43f79..1c2948ae44b915f9b244e20f01a07b4575c61521 100644 --- a/man/getWaterML1Data.Rd +++ b/man/getWaterML1Data.Rd @@ -2,21 +2,21 @@ \alias{getWaterML1Data} \title{Function to return data from the NWISWeb WaterML1.1 service} \usage{ -getWaterML1Data(obs_url) + getWaterML1Data(obs_url) } \arguments{ \item{obs_url}{string containing the url for the retrieval} } \value{ -mergedDF a data frame containing columns agency, site, -dateTime, values, and remark codes for all requested -combinations + mergedDF a data frame containing columns agency, site, + dateTime, values, and remark codes for all requested + combinations } \description{ -This function accepts a url parameter that already contains -the desired NWIS site, parameter code, statistic, startdate -and enddate. + This function accepts a url parameter that already + contains the desired NWIS site, parameter code, + statistic, startdate and enddate. } \examples{ sites <- "02177000" diff --git a/man/getWaterML2Data.Rd b/man/getWaterML2Data.Rd index ee6372c47ff03753e45acb6c4260f2448a7a5366..0c747e83688d3d298d09a95f8f61be2809265d1d 100644 --- a/man/getWaterML2Data.Rd +++ b/man/getWaterML2Data.Rd @@ -2,20 +2,20 @@ \alias{getWaterML2Data} \title{Function to return data from the WaterML2 data} \usage{ -getWaterML2Data(obs_url) + getWaterML2Data(obs_url) } \arguments{ \item{obs_url}{string containing the url for the retrieval} } \value{ -mergedDF a data frame containing columns agency, site, -dateTime, values, and remark codes for all requested -combinations + mergedDF a data frame containing columns agency, site, + dateTime, values, and remark codes for all requested + combinations } \description{ -This function accepts a url parameter for a WaterML2 -getObservation + This function accepts a url parameter for a WaterML2 + getObservation } \examples{ URL <- "http://webvastage6.er.usgs.gov/ogc-swie/wml2/dv/sos?request=GetObservation&featureID=435601087432701&observedProperty=00045&beginPosition=2012-01-01&offering=Sum" diff --git a/man/mergeReport.Rd b/man/mergeReport.Rd index 120ef00b2bdec36247080c0cae2239db5ee68746..f66466308fd52d95f367657fb9bddeb9162702c2 100644 --- a/man/mergeReport.Rd +++ b/man/mergeReport.Rd @@ -2,7 +2,8 @@ \alias{mergeReport} \title{Merge Sample and Daily Data for WRTDS} \usage{ -mergeReport(localDaily = Daily, localSample = Sample, interactive = TRUE) + mergeReport(localDaily = Daily, localSample = Sample, + interactive = TRUE) } \arguments{ \item{localDaily}{dataframe containing the daily data, @@ -16,11 +17,11 @@ mergeReport(localDaily = Daily, localSample = Sample, interactive = TRUE) data checks.} } \value{ -newSample dataframe with merged flow information + newSample dataframe with merged flow information } \description{ -Merges the flow data from the daily record into the sample -record. + Merges the flow data from the daily record into the + sample record. } \examples{ # These examples require an internet connection to run @@ -29,8 +30,8 @@ Sample <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31') Sample <- mergeReport() } \seealso{ -\code{\link{getDVData}}, -\code{\link{populateSampleColumns}} + \code{\link{getDVData}}, + \code{\link{populateSampleColumns}} } \keyword{USGS} \keyword{WRTDS} diff --git a/man/padVariable.Rd b/man/padVariable.Rd index 78b7545f4a083114d0e73cf95593b6b9bb059cb6..cf3aee545f2616faa1b17dcc20135c43ea3b97f8 100644 --- a/man/padVariable.Rd +++ b/man/padVariable.Rd @@ -2,7 +2,7 @@ \alias{padVariable} \title{Pad string with leading zeros} \usage{ -padVariable(x, padTo) + padVariable(x, padTo) } \arguments{ \item{x}{string} @@ -10,11 +10,11 @@ padVariable(x, padTo) \item{padTo}{number Final desired length of the string} } \value{ -x string returned with leading zeros + x string returned with leading zeros } \description{ -Function to pad a string with leading zeros. Useful for -parameter codes and USGS site IDs. + Function to pad a string with leading zeros. Useful for + parameter codes and USGS site IDs. } \examples{ pCode <- '10' diff --git a/man/parameterCdFile.Rd b/man/parameterCdFile.Rd index 5fa4a02f9eab8bdef7bc0dc32ef97996561b7f60..d6a4416372af38f5db25592a2026d97b8653f192 100644 --- a/man/parameterCdFile.Rd +++ b/man/parameterCdFile.Rd @@ -3,9 +3,10 @@ \alias{parameterCdFile} \title{List of USGS parameter codes} \description{ -Complete list of USGS parameter codes as of September 25, -2013. + Complete list of USGS parameter codes as of September 25, + 2013. } \keyword{USGS} +\keyword{datasets} \keyword{parameterCd} diff --git a/man/populateConcentrations.Rd b/man/populateConcentrations.Rd index 4e17c04523c345c2e54fb39ca176fa3cc3b0f415..14b30908b3a1b6f687a8b641c60d9d0a00c87414 100644 --- a/man/populateConcentrations.Rd +++ b/man/populateConcentrations.Rd @@ -2,17 +2,18 @@ \alias{populateConcentrations} \title{Populate Concentration Columns} \usage{ -populateConcentrations(rawData) + populateConcentrations(rawData) } \arguments{ \item{rawData}{vector with value and code columns} } \value{ -concentrationColumns dataframe + concentrationColumns dataframe } \description{ -Creates ConcLow, ConcHigh, Uncen (0 if censored, 1 if -uncensored) columns for Sample data frame for WRTDS study. + Creates ConcLow, ConcHigh, Uncen (0 if censored, 1 if + uncensored) columns for Sample data frame for WRTDS + study. } \examples{ code <- c("","<","") diff --git a/man/populateDaily.Rd b/man/populateDaily.Rd index ae00ff554a937fd3bc398aab2fe408e9aea7b0f9..17b7ddd74e351dadf310ac4ee1cfb9747b4d99b8 100644 --- a/man/populateDaily.Rd +++ b/man/populateDaily.Rd @@ -2,7 +2,7 @@ \alias{populateDaily} \title{Populate Daily data frame} \usage{ -populateDaily(rawData, qConvert, interactive = TRUE) + populateDaily(rawData, qConvert, interactive = TRUE) } \arguments{ \item{rawData}{dataframe contains at least dateTime, @@ -16,12 +16,12 @@ populateDaily(rawData, qConvert, interactive = TRUE) data checks.} } \value{ -dataframe Daily + dataframe Daily } \description{ -Using raw data that has at least dateTime, value, code, -populates the rest of the basic Daily data frame used in -WRTDS + Using raw data that has at least dateTime, value, code, + populates the rest of the basic Daily data frame used in + WRTDS } \examples{ dateTime <- c('1985-01-01', '1985-01-02', '1985-01-03') @@ -31,7 +31,7 @@ dataInput <- data.frame(dateTime, value, code, stringsAsFactors=FALSE) Daily <- populateDaily(dataInput, 2) } \author{ -Robert M. Hirsch \email{rhirsch@usgs.gov} + Robert M. Hirsch \email{rhirsch@usgs.gov} } \keyword{WRTDS} \keyword{flow} diff --git a/man/populateDateColumns.Rd b/man/populateDateColumns.Rd index e74551f2a57e471a76be2a595764ed047765a87a..0db70e8dac1c8a0c0d483d8076dbbd2441b6e9c1 100644 --- a/man/populateDateColumns.Rd +++ b/man/populateDateColumns.Rd @@ -2,16 +2,16 @@ \alias{populateDateColumns} \title{Populate Date Columns} \usage{ -populateDateColumns(rawData) + populateDateColumns(rawData) } \arguments{ \item{rawData}{vector with dateTime} } \value{ -DateFrame dataframe + DateFrame dataframe } \description{ -Creates various date columns for WRTDS study. + Creates various date columns for WRTDS study. } \examples{ dateTime <- c('1984-01-01', '1985-01-02', '1986-01-03') diff --git a/man/populateParameterINFO.Rd b/man/populateParameterINFO.Rd index 2571ef3858622ab4c8c5d0d7c6f3cebcfc11907d..695a65d08d98375adf4e338e4a7702e89c251143 100644 --- a/man/populateParameterINFO.Rd +++ b/man/populateParameterINFO.Rd @@ -2,7 +2,8 @@ \alias{populateParameterINFO} \title{Populate Parameter Information Columns} \usage{ -populateParameterINFO(parameterCd, localINFO = INFO, interactive = TRUE) + populateParameterINFO(parameterCd, localINFO = INFO, + interactive = TRUE) } \arguments{ \item{localINFO}{dataframe with value and code columns. @@ -15,11 +16,11 @@ populateParameterINFO(parameterCd, localINFO = INFO, interactive = TRUE) data checks.} } \value{ -localINFO dataframe + localINFO dataframe } \description{ -Populates INFO data frame with additional user-supplied -information concerning the measured parameter. + Populates INFO data frame with additional user-supplied + information concerning the measured parameter. } \examples{ #This example requires an internet connection to run diff --git a/man/populateSampleColumns.Rd b/man/populateSampleColumns.Rd index d22334a22df295fb7cbe0741a830b3e1b7165f57..e7a10161bd6984ec08eac0d989f9470368cd116f 100644 --- a/man/populateSampleColumns.Rd +++ b/man/populateSampleColumns.Rd @@ -2,18 +2,18 @@ \alias{populateSampleColumns} \title{Populate Sample Columns} \usage{ -populateSampleColumns(rawData) + populateSampleColumns(rawData) } \arguments{ \item{rawData}{dataframe with dateTime, ConcLow, ConcHigh, Uncen} } \value{ -Sample2 dataframe + Sample2 dataframe } \description{ -Creates ConcAve and ConcLow based on Uncen. Removes any -samples with NA values in ConcHigh + Creates ConcAve and ConcLow based on Uncen. Removes any + samples with NA values in ConcHigh } \examples{ dateTime <- c('1985-01-01', '1985-01-02', '1985-01-03') diff --git a/man/populateSiteINFO.Rd b/man/populateSiteINFO.Rd index 7095cf68837e6effc1bf67142ddb56eafc8804b0..ac90811d19a6ba630d697f101d24b3bba1f015f6 100644 --- a/man/populateSiteINFO.Rd +++ b/man/populateSiteINFO.Rd @@ -2,7 +2,7 @@ \alias{populateSiteINFO} \title{Populate Site Information Columns} \usage{ -populateSiteINFO(INFO, siteNumber, interactive = TRUE) + populateSiteINFO(INFO, siteNumber, interactive = TRUE) } \arguments{ \item{INFO}{dataframe with value and code columns} @@ -14,12 +14,12 @@ populateSiteINFO(INFO, siteNumber, interactive = TRUE) data checks.} } \value{ -INFO dataframe + INFO dataframe } \description{ -Populates INFO data frame with additional user-supplied -information. Also removes fields not related to WRTDS -study. + Populates INFO data frame with additional user-supplied + information. Also removes fields not related to WRTDS + study. } \examples{ #This example requires an internet connection to run diff --git a/man/processQWData.Rd b/man/processQWData.Rd index 8c3d83fd8fbb7e759bab0dfacb57c8b988969a1f..660c8bb571bcef093ad463a30d4d779727da1c13 100644 --- a/man/processQWData.Rd +++ b/man/processQWData.Rd @@ -2,23 +2,23 @@ \alias{processQWData} \title{Processing of USGS NWIS Water Quality Data} \usage{ -processQWData(data) + processQWData(data) } \arguments{ \item{data}{dataframe from} } \value{ -data dataframe with first column dateTime, and at least one -qualifier and value columns (subsequent qualifier/value -columns could follow depending on the number of parameter -codes) + data dataframe with first column dateTime, and at least + one qualifier and value columns (subsequent + qualifier/value columns could follow depending on the + number of parameter codes) } \description{ -Processes water quality portal data. This function looks at -detection limit and detection conditions to determine if a -value is left censored or not. Censored values are given -the qualifier "<". The dataframe is also converted from a -long to wide format. + Processes water quality portal data. This function looks + at detection limit and detection conditions to determine + if a value is left censored or not. Censored values are + given the qualifier "<". The dataframe is also converted + from a long to wide format. } \examples{ # These examples require an internet connection to run diff --git a/man/removeDuplicates.Rd b/man/removeDuplicates.Rd index 979f6a3252d165c5317c092a07728d7a7c1b83b9..a68826fd301415d60465fce1001c5167cbe59219 100644 --- a/man/removeDuplicates.Rd +++ b/man/removeDuplicates.Rd @@ -2,19 +2,19 @@ \alias{removeDuplicates} \title{Remove Duplicates} \usage{ -removeDuplicates(localSample = Sample) + removeDuplicates(localSample = Sample) } \arguments{ \item{localSample}{dataframe with at least DecYear and ConcHigh, default name is Sample} } \value{ -Sample1 dataframe + Sample1 dataframe } \description{ -Removes observations from the data frame Sample when the -observation has the identical date and value as another -observation + Removes observations from the data frame Sample when the + observation has the identical date and value as another + observation } \examples{ DecYear <- c('1985.01', '1985.01', '1985.02', '1985.02', '1985.03') diff --git a/man/renameColumns.Rd b/man/renameColumns.Rd index 22bb81cedcb824ec6dea8a581edcc28ba49ecd3e..2ed426adfd8e344186d20be8211cc1ee62d1546c 100644 --- a/man/renameColumns.Rd +++ b/man/renameColumns.Rd @@ -2,17 +2,17 @@ \alias{renameColumns} \title{renameColumns} \usage{ -renameColumns(rawData) + renameColumns(rawData) } \arguments{ \item{rawData}{dataframe returned from retrieval functions} } \value{ -rawData dataframe with improved column names + rawData dataframe with improved column names } \description{ -Rename columns coming back from NWIS data retrievals + Rename columns coming back from NWIS data retrievals } \examples{ # This example requires an internet connection to run diff --git a/man/retrieveNWISData.Rd b/man/retrieveNWISData.Rd index 27a746ce0470fc59b2c87d885969539d6a6fa2a2..bfcd0d82d3684f4687c36973b2b89ec992d7057b 100644 --- a/man/retrieveNWISData.Rd +++ b/man/retrieveNWISData.Rd @@ -2,8 +2,9 @@ \alias{retrieveNWISData} \title{Raw Data Import for USGS NWIS Data} \usage{ -retrieveNWISData(siteNumber, ParameterCd, StartDate, EndDate, - StatCd = "00003", format = "tsv", interactive = TRUE) + retrieveNWISData(siteNumber, ParameterCd, StartDate, + EndDate, StatCd = "00003", format = "tsv", + interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -37,16 +38,16 @@ retrieveNWISData(siteNumber, ParameterCd, StartDate, EndDate, data checks.} } \value{ -data dataframe with agency, site, dateTime, value, and code -columns + data dataframe with agency, site, dateTime, value, and + code columns } \description{ -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://help.waterdata.usgs.gov/codes-and-parameters/parameters} -A list of statistic codes can be found here: -\url{http://help.waterdata.usgs.gov/code/stat_code_query?fmt=html} + 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://help.waterdata.usgs.gov/codes-and-parameters/parameters} + A list of statistic codes can be found here: + \url{http://help.waterdata.usgs.gov/code/stat_code_query?fmt=html} } \examples{ # These examples require an internet connection to run diff --git a/man/retrieveNWISqwData.Rd b/man/retrieveNWISqwData.Rd index ae2ccb1b0732f489e5f58a0a4818f8543c5e9636..e7ef52290e23110daaaee417285e261f88f30b87 100644 --- a/man/retrieveNWISqwData.Rd +++ b/man/retrieveNWISqwData.Rd @@ -2,8 +2,8 @@ \alias{retrieveNWISqwData} \title{Raw Data Import for USGS NWIS QW Data} \usage{ -retrieveNWISqwData(siteNumber, pCodes, startDate, endDate, expanded = FALSE, - interactive = TRUE) + retrieveNWISqwData(siteNumber, pCodes, startDate, + endDate, expanded = FALSE, interactive = TRUE) } \arguments{ \item{siteNumber}{string or vector of strings USGS site @@ -31,17 +31,17 @@ retrieveNWISqwData(siteNumber, pCodes, startDate, endDate, expanded = FALSE, data checks.} } \value{ -data dataframe with agency, site, dateTime, value, and code -columns + data dataframe with agency, site, dateTime, value, and + code columns } \description{ -Imports data from NWIS web service. This function gets the -data from here: -\url{http://nwis.waterdata.usgs.gov/nwis/qwdata} 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} + Imports data from NWIS web service. This function gets + the data from here: + \url{http://nwis.waterdata.usgs.gov/nwis/qwdata} 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} } \examples{ # These examples require an internet connection to run diff --git a/man/retrieveUnitNWISData.Rd b/man/retrieveUnitNWISData.Rd index e3599824a06e0a901bcb6d480a80e80ff9a881f5..05e4bd29288ce6e2318022fa2f8bba1d78be1f2a 100644 --- a/man/retrieveUnitNWISData.Rd +++ b/man/retrieveUnitNWISData.Rd @@ -2,8 +2,8 @@ \alias{retrieveUnitNWISData} \title{Raw Data Import for Instantaneous USGS NWIS Data} \usage{ -retrieveUnitNWISData(siteNumber, ParameterCd, StartDate, EndDate, - format = "xml", interactive = TRUE) + retrieveUnitNWISData(siteNumber, ParameterCd, StartDate, + EndDate, format = "xml", interactive = TRUE) } \arguments{ \item{siteNumber}{string USGS site number. This is @@ -34,16 +34,16 @@ retrieveUnitNWISData(siteNumber, ParameterCd, StartDate, EndDate, expected. The default is therefore "xml".} } \value{ -data dataframe with agency, site, dateTime, time zone, -value, and code columns + data dataframe with agency, site, dateTime, time zone, + value, and code columns } \description{ -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/} A list -of statistic codes can be found here: -\url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} + 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/} A list + of statistic codes can be found here: + \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table} } \examples{ siteNumber <- '05114000'