diff --git a/DESCRIPTION b/DESCRIPTION index cfeac6c5670a1a02758c293e2f07e1232f481b02..a144b79dd37afcf7b922786b16a68164e953c819 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -13,47 +13,6 @@ Copyright: This software is in the public domain because it contains materials 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 -Collate: - 'tabbedDataRetrievals.R' - 'retrieveNWISData.r' - 'getQWData.r' - 'getSiteFileData.r' - 'getDataFromFile.r' - 'getParameterInfo.r' - 'checkStartEndDate.r' - 'dateFormatCheck.r' - 'formatCheckDate.r' - 'formatCheckParameterCd.r' - 'formatCheckSiteNumber.r' - 'getQWDataFromFile.r' - 'populateDaily.r' - 'compressData.r' - 'populateSampleColumns.r' - 'populateDateColumns.r' - 'populateConcentrations.r' - 'populateSiteINFO.r' - 'populateParameterINFO.r' - 'removeDuplicates.r' - 'getDVData.r' - 'getDailyDataFromFile.r' - 'getSampleData.r' - 'getSampleDataFromFile.r' - 'getMetaData.r' - 'mergeReport.r' - 'dataOverview.r' - 'getWQPData.r' - 'retrieveUnitNWISData.r' - 'getRawQWData.r' - 'retrieveNWISqwData.r' - 'processQWData.r' - 'constructNWISURL.r' - 'getDataAvailability.r' - 'getWaterML1Data.r' - 'padVariable.r' - 'getRDB1Data.r' - 'getSTORETSampleData.R' - 'getWaterML2Data.r' - 'renameColumns.R' Depends: R (>= 3.0) Imports: diff --git a/man/ChoptankRiverFlow.Rd b/man/ChoptankRiverFlow.Rd index e3220cb26ec899e18cb50eb3f1fc2dac85c74705..8bfe9ca2847a9d43687748b43cf47cd68f45917f 100644 --- a/man/ChoptankRiverFlow.Rd +++ b/man/ChoptankRiverFlow.Rd @@ -3,14 +3,13 @@ \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 435899d342946191abe385cedfaadce4fe6ff37e..e7bff34301ca6d82fa07770002820a8307349788 100644 --- a/man/ChoptankRiverNitrate.Rd +++ b/man/ChoptankRiverNitrate.Rd @@ -3,16 +3,15 @@ \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 ce5da41b9ff354cc6a75844912f837221ac37adb..79b0c57ba60a51b825923a6994a1b1c6aaadcca7 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 @@ 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 143dbcc72c6db7959e9542ad30dd7800b2b225ab..610716850da2e9247f02abd1390b5779d16cccc2 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 @@ 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 69e70cecc0627af3f24b0a861b11b7e1e4c33264..6d55f6e3adca5c0c9b76908063593d17149e6687 100644 --- a/man/constructNWISURL.Rd +++ b/man/constructNWISURL.Rd @@ -2,9 +2,8 @@ \alias{constructNWISURL} \title{Construct NWIS url for data retrieval} \usage{ - constructNWISURL(siteNumber, parameterCd, startDate, - endDate, service, statCd = "00003", format = "xml", - interactive = TRUE) +constructNWISURL(siteNumber, parameterCd, startDate, endDate, service, + statCd = "00003", format = "xml", interactive = TRUE) } \arguments{ \item{siteNumber}{string or vector of strings USGS site @@ -44,16 +43,16 @@ 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 6fe56a3ac2930bf546840bcbdb75fea354dadd3f..740a0591aee69a7e14ec3e27a316fbe36e299ac2 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 @@ \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 055aa874443eceef6efd9efdc9fce3983d7e5c5a..ea978468281dbd65d3b6249d20785356ecb06e7e 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 dd75fee619a69001adad54bba538e9d5980ee496..c27c908fb22619e02e1277fa7688d9b2f24eee25 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 64c54b65061785ecf5741d3f1c4eac8c9ac3af0d..eaca3155e5c6aa3c4bf67c1564e95e2fb8ee4ed1 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 @@ 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 a506bd85e0ba4eda3d47c926635ed44c98a33fb8..416b9dbaf73b4508e727439c8877c5d64b6cc126 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 @@ 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 2f16232501e4729fb68393c7cbb60ff70116ad3b..fabd0d594e646a9953c069bd20958cfdca8d639b 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,15 +12,17 @@ data checks.} } \value{ - siteNumber string +siteNumber string } \description{ - Checks that the site code is 8 digits. If it is not 8 - digits, 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' formatCheckSiteNumber(site) +site_incorrect <- '1234567' +formatCheckSiteNumber(site_incorrect) } \keyword{WRTDS} \keyword{flow} diff --git a/man/getDVData.Rd b/man/getDVData.Rd index ecb58f4f9f3b6c61af010e3f3be8ed740efd8d0a..e4e5e188261b387317b45bfc3da9e4f312bf613b 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 @@ 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,8 +58,7 @@ 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 2c8ded37b9a18f130b42c18ecc9f4d3787a3c696..1c11d5872e340fc945998defbc74644eaafaa4a3 100644 --- a/man/getDailyDataFromFile.Rd +++ b/man/getDailyDataFromFile.Rd @@ -2,9 +2,8 @@ \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} @@ -26,12 +25,11 @@ 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{ # Examples of how to use getDailyDataFromFile: diff --git a/man/getDataAvailability.Rd b/man/getDataAvailability.Rd index 29f79bc3de6cb6b8da103aa493be93de13b5eeaa..db1119da6c0ad8626c6b171f1470681dbf4be8dc 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 @@ 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 7ec446f59216b6173dead3192e11d6cd46fb0a08..93b1c0c1c411b0ed2cae696cef18d556c8353aa3 100644 --- a/man/getDataFromFile.Rd +++ b/man/getDataFromFile.Rd @@ -2,8 +2,7 @@ \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} @@ -17,14 +16,14 @@ 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 91ae02d37af2334be85e06624148abed504efe14..74d12b932f23983320e81ba8fd338efd9e6a56b4 100644 --- a/man/getMetaData.Rd +++ b/man/getMetaData.Rd @@ -2,8 +2,7 @@ \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 @@ -17,22 +16,22 @@ 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 2cfa2d1cad594c411b0ad17dde28ecb881046a1b..004b6fd27bc4736a0139514318e0797a57dec443 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 @@ 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 70f7885ccba58ef2dd0f5a29dcd5e4d5f2481bbf..eb2d7f3745b0c5653b43b05b6fb2e81500d90536 100644 --- a/man/getQWData.Rd +++ b/man/getQWData.Rd @@ -2,8 +2,7 @@ \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 @@ -26,19 +25,19 @@ 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 1303449e53bd8b0d45a379c661ae17f392bf6d38..2822df05424b36257a448fd9190fd35b89688588 100644 --- a/man/getQWDataFromFile.Rd +++ b/man/getQWDataFromFile.Rd @@ -2,8 +2,7 @@ \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} @@ -17,16 +16,16 @@ 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 6777c95a5b7ebe752f727a1f2b0244d9aee59aab..f272321bbcc1bbbf2ecbf961a1cb6c2405cb32b7 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 @@ 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 b1aaccf3f4ba98c5ba10aa23757614e4391ceb92..585aa3635dcf7502ef2aab3c3224e21daf89c2e3 100644 --- a/man/getRawQWData.Rd +++ b/man/getRawQWData.Rd @@ -2,8 +2,7 @@ \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 @@ -24,18 +23,18 @@ 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 5fe9a4d79738ad6db7a43422ef8e43a398527567..80ddabea2676f3f7e50c37e39b86450a53baca1a 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 @@ 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 51fa28ff1bfdfa33f6b2a1b347002e4153e8dd5d..a51361c63a3ab4e14a04ad48e8fa9c98c061213d 100644 --- a/man/getSampleData.Rd +++ b/man/getSampleData.Rd @@ -2,8 +2,7 @@ \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 @@ -23,19 +22,19 @@ 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 @@ -44,8 +43,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 9ab9723ca0fc1518b3bd5d724b7adcf6a7861a01..143bdb3843ff98bc8ba7362d5ae66956073fd1e2 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 @@ 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{ # Examples of how to use getSampleDataFromFile: diff --git a/man/getSiteFileData.Rd b/man/getSiteFileData.Rd index 56f3fdff84903dc5f704b46179269f3660fb5867..c71037b80492153e6bbfc08f223f56d13df77072 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 @@ 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 a3b275d477aa664bc684d798eb3b33d64ddcf9f5..4ae5b2b914b749a76fbdf5476f162799333ddeaa 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,21 +22,20 @@ 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 5f62dc79ab951e77d2905b2a4d2f9d4de1046c8c..8e5ab86f928a852ebc3666f31f94d2430fab90a8 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{ url <- "http://waterservices.usgs.gov/nwis/dv/?format=waterml,1.1&sites=" diff --git a/man/getWaterML2Data.Rd b/man/getWaterML2Data.Rd index 0c747e83688d3d298d09a95f8f61be2809265d1d..ee6372c47ff03753e45acb6c4260f2448a7a5366 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 f66466308fd52d95f367657fb9bddeb9162702c2..120ef00b2bdec36247080c0cae2239db5ee68746 100644 --- a/man/mergeReport.Rd +++ b/man/mergeReport.Rd @@ -2,8 +2,7 @@ \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, @@ -17,11 +16,11 @@ 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 @@ -30,8 +29,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 cf3aee545f2616faa1b17dcc20135c43ea3b97f8..78b7545f4a083114d0e73cf95593b6b9bb059cb6 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 @@ \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 d6a4416372af38f5db25592a2026d97b8653f192..5fa4a02f9eab8bdef7bc0dc32ef97996561b7f60 100644 --- a/man/parameterCdFile.Rd +++ b/man/parameterCdFile.Rd @@ -3,10 +3,9 @@ \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 14b30908b3a1b6f687a8b641c60d9d0a00c87414..4e17c04523c345c2e54fb39ca176fa3cc3b0f415 100644 --- a/man/populateConcentrations.Rd +++ b/man/populateConcentrations.Rd @@ -2,18 +2,17 @@ \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 17b7ddd74e351dadf310ac4ee1cfb9747b4d99b8..ae00ff554a937fd3bc398aab2fe408e9aea7b0f9 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 @@ 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 0db70e8dac1c8a0c0d483d8076dbbd2441b6e9c1..e74551f2a57e471a76be2a595764ed047765a87a 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 695a65d08d98375adf4e338e4a7702e89c251143..2571ef3858622ab4c8c5d0d7c6f3cebcfc11907d 100644 --- a/man/populateParameterINFO.Rd +++ b/man/populateParameterINFO.Rd @@ -2,8 +2,7 @@ \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. @@ -16,11 +15,11 @@ 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 e7a10161bd6984ec08eac0d989f9470368cd116f..d22334a22df295fb7cbe0741a830b3e1b7165f57 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 ac90811d19a6ba630d697f101d24b3bba1f015f6..7095cf68837e6effc1bf67142ddb56eafc8804b0 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 @@ 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 660c8bb571bcef093ad463a30d4d779727da1c13..8c3d83fd8fbb7e759bab0dfacb57c8b988969a1f 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 a68826fd301415d60465fce1001c5167cbe59219..979f6a3252d165c5317c092a07728d7a7c1b83b9 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 2ed426adfd8e344186d20be8211cc1ee62d1546c..22bb81cedcb824ec6dea8a581edcc28ba49ecd3e 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 bfcd0d82d3684f4687c36973b2b89ec992d7057b..27a746ce0470fc59b2c87d885969539d6a6fa2a2 100644 --- a/man/retrieveNWISData.Rd +++ b/man/retrieveNWISData.Rd @@ -2,9 +2,8 @@ \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 @@ -38,16 +37,16 @@ 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 40903e1e889a3b73361054a10a881efd0253cacf..714521c4b57c7355867c60fdd306771665a5a4e9 100644 --- a/man/retrieveNWISqwData.Rd +++ b/man/retrieveNWISqwData.Rd @@ -2,8 +2,7 @@ \alias{retrieveNWISqwData} \title{Raw Data Import for USGS NWIS QW Data} \usage{ - retrieveNWISqwData(siteNumber, pCodes, startDate, - endDate, interactive = TRUE) +retrieveNWISqwData(siteNumber, pCodes, startDate, endDate, interactive = TRUE) } \arguments{ \item{siteNumber}{string or vector of strings USGS site @@ -23,17 +22,17 @@ 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 05e4bd29288ce6e2318022fa2f8bba1d78be1f2a..e3599824a06e0a901bcb6d480a80e80ff9a881f5 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 @@ 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'