diff --git a/NAMESPACE b/NAMESPACE index 6f759704bc0462ec8347309037235671beacac6f..35aff21d1b6fc7d5b2b39ad396078454113f1b9b 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -2,17 +2,6 @@ export(constructNWISURL) export(constructWQPURL) -export(getNWISData) -export(getNWISDataAvailability) -export(getNWISPcodeInfo) -export(getNWISSiteInfo) -export(getNWISSites) -export(getNWISdvData) -export(getNWISqwData) -export(getNWISunitData) -export(getWQPData) -export(getWQPSites) -export(getWQPqwData) export(importRDB1) export(importWQP) export(importWaterML1) diff --git a/NEWS b/NEWS index 4730eb040b2c1a6edf6efd2e823c9b4f9e87d944..0b199d2b90776c93a32738a4e7025b749fd713ba 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,10 @@ +dataRetrieval 2.0.1 +=========== +* Removed deprecated functions. +* Added siteInfo and variableInfo dataframe attributes to all data retrival functions +* Improved help files +* Added data file (pCodeToName) that shows the association of USGS parameter code to characteristicName + dataRetrieval 2.0.0 =========== * Overhaul of function names based on initial user feedback diff --git a/R/deprecatedFunctions.R b/R/deprecatedFunctions.R deleted file mode 100644 index 61167e184649112c421d2bdd683c73a72b89c717..0000000000000000000000000000000000000000 --- a/R/deprecatedFunctions.R +++ /dev/null @@ -1,81 +0,0 @@ -#' @rdname whatNWISsites -#' @export -getNWISSites<- function(...){ - message("This function is being deprecated. Please use whatNWISsites in the future.") - whatNWISsites(...) -} - -#' @rdname whatNWISdata -#' @export -getNWISDataAvailability <- function(siteNumbers,service=c("uv","dv","qw")){ - message("This function is being deprecated. Please use whatNWISdata in the future.") - whatNWISdata(siteNumbers, service=service) -} - - -#' @rdname whatWQPsites -#' @export -getWQPSites<- function(...){ - message("This function is being deprecated. Please use whatWQPsites in the future.") - whatWQPsites(...) -} - -#' @rdname readNWISsite -#' @export -getNWISSiteInfo<- function(siteNumbers){ - message("This function is being deprecated. Please use readNWISsite in the future.") - readNWISsite(siteNumbers) -} - -#' @rdname readNWISpCode -#' @export -getNWISPcodeInfo<- function(parameterCd){ - message("This function is being deprecated. Please use readNWISpCode in the future.") - readNWISpCode(parameterCd) -} - -#' @rdname readNWISdata -#' @export -getNWISData<- function(service="dv", ...){ - message("This function is being deprecated. Please use readNWISdata in the future.") - readNWISdata(service=service, ...) -} - -#' @rdname readNWISdv -#' @export -getNWISdvData<- function(siteNumber,parameterCd,startDate="",endDate="",statCd="00003"){ - message("This function is being deprecated. Please use readNWISdv in the future.") - readNWISdv(siteNumber,parameterCd,startDate,endDate,statCd) -} - -#' @rdname readNWISuv -#' @export -getNWISunitData<- function(siteNumbers,parameterCd,startDate="",endDate="", tz=""){ - message("This function is being deprecated. Please use readNWISuv in the future.") - readNWISuv(siteNumbers,parameterCd,startDate,endDate, tz) -} - -#' @rdname readNWISqw -#' @export -getNWISqwData<- function(siteNumber,pCodes,startDate="",endDate="", - expanded=FALSE,reshape=TRUE,tz=""){ - message("This function is being deprecated. Please use readNWISqw in the future.") - readNWISqw(siteNumber,pCodes,startDate,endDate, - expanded,reshape,tz) -} - -#' @rdname readWQPqw -#' @export -getWQPqwData<- function(siteNumber,parameterCd,startDate="",endDate=""){ - message("This function is being deprecated. Please use readWQPqw in the future.") - readWQPqw(siteNumber,parameterCd,startDate,endDate) -} - -#' @rdname readWQPdata -#' @export -getWQPData<- function(...){ - message("This function is being deprecated. Please use readWQPdata in the future.") - readWQPdata(...) -} - - diff --git a/R/tabbedDataRetrievals.R b/R/tabbedDataRetrievals.R index 9bfb4c755a54359e25dd3086fd541c0a46ab2203..38e79cf6d415a427e639b8dd59147fd1ef4e28fd 100644 --- a/R/tabbedDataRetrievals.R +++ b/R/tabbedDataRetrievals.R @@ -14,7 +14,9 @@ #' LazyLoad: \tab yes\cr #' } #' -#' Retrieval functions for USGS and EPA hydrologic and water quality data +#' Retrieval functions for USGS and EPA hydrologic and water quality data. +#' +#' Please see \url{http://pubs.usgs.gov/tm/04/a10/} for more information. #' #' @name dataRetrieval-package #' @docType package diff --git a/README.md b/README.md index b61e5deb510093d9abc69f818a56fdbe35acdae1..569af5d2e0bd365ecdc54e6e566e45e365b17b3c 100644 --- a/README.md +++ b/README.md @@ -18,35 +18,29 @@ Web service retrieval functions: |Function | Inputs | Description | | -------------| ------------------------|:-------------| -|`readNWISdata` | `...`, service | NWIS data using user-specified queries | -|`readNWISdv` | `Common 3`, parameter code, statCd | NWIS daily data with `Common` query | -|`readNWISqw` | `Common 3`, parameter code, expanded | NWIS water quality data with `Common` query | -|`readNWISuv` | `Common 3`, parameter code | NWIS instantaneous data with `Common` query | -|`readNWISpCode` | parameterCd | NWIS parameter code information | +|`readNWISdata` | `...`, `service` | NWIS data using user-specified queries | +|`readNWISdv` | `Common 3`, `parameterCd`, `statCd` | NWIS daily data with `Common` query | +|`readNWISqw` | `Common 3`, `parameterCd`, `expanded` | NWIS water quality data with `Common` query | +|`readNWISuv` | `Common 3`, `parameterCd` | NWIS instantaneous data with `Common` query | +|`readNWISpCode` | `parameterCd` | NWIS parameter code information | |`readNWISgwl` | `Common 3` | NWIS groundwater level data with `Common` query | |`readNWISpeak` | `Common 3` | NWIS peak flow data with `Common` query | |`readNWISmeas` | `Common 3` | NWIS surface-water measurement data with `Common` query | -|`readNWISrating` | siteNumber, type | NWIS rating table for an active USGS streamgage | -|`readNWISsite` | siteNumber | NWIS site information | +|`readNWISrating` | `siteNumber`, `type` | NWIS rating table for an active USGS streamgage | +|`readNWISsite` | `siteNumber` | NWIS site information | |`whatNWISsites` | `...` | NWIS site search using user-specified queries | -|`whatNWISdata` | siteNumber, service | NWIS data availability, including period of record and count | +|`whatNWISdata` | `siteNumber`, `service` | NWIS data availability, including period of record and count | |`readWQPdata` | `...` | WQP data using user-specified queries | |`readWQPqw` | `Common 3` | WQP data with `Common 3` query and either parameter code or characteristic name| |`whatWQPsites` | `...` | WQP site search using user-specified queries | * `Common 3` = siteNumber, startDate, endDate -Moving `EGRET` specific functions to `EGRET` (version 2.0.0 and greater): - +##Reporting bugs -|Information Source | Meta Data | Data | -| -------------| -------------| ------------- |:-------------| -|NWIS | `readNWISInfo` | `readNWISSample` | -| | | `readNWISDaily` | -| Water Quality Portal | `readWQPInfo`| `readWQPSample` | -| User-supplied files | `readUserInfo` | `readUserDaily`| -| | | `readUserSample` | +Please consider reporting bugs and asking questions on the Issues page: +[https://github.com/USGS-R/dataRetrieval/issues](https://github.com/USGS-R/dataRetrieval/issues) ##Subscribe @@ -55,11 +49,7 @@ egret_comments@usgs.gov Additionally, to subscribe to an email list concerning updates to these R packages, please send a request to egret_comments@usgs.gov. -##Reporting bugs -Please consider reporting bugs and asking questions on the Issues page: - -[https://github.com/USGS-R/dataRetrieval/issues](https://github.com/USGS-R/dataRetrieval/issues) ##Package Installation To install the dataRetrieval package, you must be using R 3.0 or greater and run the following command: @@ -69,10 +59,27 @@ To install the dataRetrieval package, you must be using R 3.0 or greater and run ##Version updates --------------- +###dataRetrieval 2.0.1 +* Improved help files and vignette documentation +* Added siteInfo and variableInfo attributes to returned data frames +* Removed any obsolete functions + ###dataRetrieval 2.0.0 -* Changing naming convention. Migrated `EGRET` specific retrievals to `EGRET` +* Changing naming convention. Migrated `EGRET` specific retrievals to `EGRET`: + +Moving `EGRET` specific functions to `EGRET` (version 2.0.0 and greater): + + +|Information Source | Meta Data | Data | +| -------------| -------------| ------------- |:-------------| +|NWIS | `readNWISInfo` | `readNWISSample` | +| | | `readNWISDaily` | +| Water Quality Portal | `readWQPInfo`| `readWQPSample` | +| User-supplied files | `readUserInfo` | `readUserDaily`| +| | | `readUserSample` | + * Added back WaterML2 parsing tool * Added specific groundwater, rating, peak, and surfacewater measurement functions * Attached metadata attributes to returned dataframes diff --git a/man/dataRetrieval-package.Rd b/man/dataRetrieval-package.Rd index 4bb467bdd366b0b25996548c75a5797efabf219c..e53bf225fafa39a45c69dd7eeeb6ffd23b15b920 100644 --- a/man/dataRetrieval-package.Rd +++ b/man/dataRetrieval-package.Rd @@ -19,7 +19,9 @@ LazyLoad: \tab yes\cr } } \details{ -Retrieval functions for USGS and EPA hydrologic and water quality data +Retrieval functions for USGS and EPA hydrologic and water quality data. + +Please see \url{http://pubs.usgs.gov/tm/04/a10/} for more information. } \author{ Robert M. Hirsch \email{rhirsch@usgs.gov}, Laura De Cicco \email{ldecicco@usgs.gov} diff --git a/man/readNWISdata.Rd b/man/readNWISdata.Rd index bdb0ca86983ea8e5a0bdfee345bcfbc33cd005b6..f9cfe9eab997a17be4cae20dedef719840e15efa 100644 --- a/man/readNWISdata.Rd +++ b/man/readNWISdata.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISData} -\alias{getNWISData} +\name{readNWISdata} \alias{readNWISdata} \title{General Data Import from NWIS} \usage{ -getNWISData(service = "dv", ...) - readNWISdata(service = "dv", ...) } \arguments{ diff --git a/man/readNWISdv.Rd b/man/readNWISdv.Rd index 5d60864b046eb7e2bd7a8ad1c6a32ad89a0d19de..54b67f21f0d3da6fdd316a14868eb05a73d234a4 100644 --- a/man/readNWISdv.Rd +++ b/man/readNWISdv.Rd @@ -1,12 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISdvData} -\alias{getNWISdvData} +\name{readNWISdv} \alias{readNWISdv} \title{Raw Data Import for USGS NWIS Data} \usage{ -getNWISdvData(siteNumber, parameterCd, startDate = "", endDate = "", - statCd = "00003") - readNWISdv(siteNumber, parameterCd, startDate = "", endDate = "", statCd = "00003") } diff --git a/man/readNWISpCode.Rd b/man/readNWISpCode.Rd index 0179c392874a97503f5a470cac62b038081b00ca..8ae5a668d8be2798f4fec57ce211fa15e0db2447 100644 --- a/man/readNWISpCode.Rd +++ b/man/readNWISpCode.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISPcodeInfo} -\alias{getNWISPcodeInfo} +\name{readNWISpCode} \alias{readNWISpCode} \title{USGS Parameter Data Retrieval} \usage{ -getNWISPcodeInfo(parameterCd) - readNWISpCode(parameterCd) } \arguments{ diff --git a/man/readNWISqw.Rd b/man/readNWISqw.Rd index 71264b87b1ea0a4637b1dafd44204d8e43702dc2..8d550027c5d12fdf185c2bfb08e98b5370558f11 100644 --- a/man/readNWISqw.Rd +++ b/man/readNWISqw.Rd @@ -1,12 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISqwData} -\alias{getNWISqwData} +\name{readNWISqw} \alias{readNWISqw} \title{Raw Data Import for USGS NWIS QW Data} \usage{ -getNWISqwData(siteNumber, pCodes, startDate = "", endDate = "", - expanded = FALSE, reshape = TRUE, tz = "") - readNWISqw(siteNumber, pCodes, startDate = "", endDate = "", expanded = FALSE, reshape = TRUE, tz = "") } diff --git a/man/readNWISsite.Rd b/man/readNWISsite.Rd index b0326ecf028d56b9d919050df5a890ac0bf5a1a5..fffc3dcbb55d8fe9d4fbbf97d12dab0b9a94bd46 100644 --- a/man/readNWISsite.Rd +++ b/man/readNWISsite.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISSiteInfo} -\alias{getNWISSiteInfo} +\name{readNWISsite} \alias{readNWISsite} \title{USGS Site File Data Retrieval} \usage{ -getNWISSiteInfo(siteNumbers) - readNWISsite(siteNumbers) } \arguments{ diff --git a/man/readNWISuv.Rd b/man/readNWISuv.Rd index d78dee06997b0cc9d7fbd06fd08ccb472d5a4055..900ebb0ebd730a674ff87dfbc1b4ace5a9088ee2 100644 --- a/man/readNWISuv.Rd +++ b/man/readNWISuv.Rd @@ -1,12 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISunitData} -\alias{getNWISunitData} +\name{readNWISuv} \alias{readNWISuv} \title{Raw Data Import for Instantaneous USGS NWIS Data} \usage{ -getNWISunitData(siteNumbers, parameterCd, startDate = "", endDate = "", - tz = "") - readNWISuv(siteNumbers, parameterCd, startDate = "", endDate = "", tz = "") } diff --git a/man/readWQPdata.Rd b/man/readWQPdata.Rd index ac1b780f842ffa02074bb28ade126dd05d2a7216..1896c1bda8ddf10c0607893d75d0c0ee7e25039a 100644 --- a/man/readWQPdata.Rd +++ b/man/readWQPdata.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getWQPData} -\alias{getWQPData} +\name{readWQPdata} \alias{readWQPdata} \title{General Data Import from Water Quality Portal} \usage{ -getWQPData(...) - readWQPdata(...) } \arguments{ diff --git a/man/readWQPqw.Rd b/man/readWQPqw.Rd index 5cf0fdfa82d517b29d55af557ef87cc3795b9d26..fcf45a26dc95e8b998018025f1b039d5ba9a4854 100644 --- a/man/readWQPqw.Rd +++ b/man/readWQPqw.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getWQPqwData} -\alias{getWQPqwData} +\name{readWQPqw} \alias{readWQPqw} \title{Raw Data Import for Water Quality Portal} \usage{ -getWQPqwData(siteNumber, parameterCd, startDate = "", endDate = "") - readWQPqw(siteNumber, parameterCd, startDate = "", endDate = "") } \arguments{ diff --git a/man/whatNWISData.Rd b/man/whatNWISData.Rd index 577e3e012f0ee6ef17c6d880d4719f8d40981c26..4675f19b375ccb9714c70fbb2e71d14e1b3e34ad 100644 --- a/man/whatNWISData.Rd +++ b/man/whatNWISData.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISDataAvailability} -\alias{getNWISDataAvailability} +\name{whatNWISdata} \alias{whatNWISdata} \title{USGS data availability} \usage{ -getNWISDataAvailability(siteNumbers, service = c("uv", "dv", "qw")) - whatNWISdata(siteNumbers, service = "all", parameterCd = "all", statCd = "all") } diff --git a/man/whatNWISsites.Rd b/man/whatNWISsites.Rd index 0b6f918742f1f71995cbdc0e67c808c3aa7987b7..6f94628446bf3bc006aebced597ae0fde9a3cf5b 100644 --- a/man/whatNWISsites.Rd +++ b/man/whatNWISsites.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getNWISSites} -\alias{getNWISSites} +\name{whatNWISsites} \alias{whatNWISsites} \title{Site Data Import from NWIS} \usage{ -getNWISSites(...) - whatNWISsites(...) } \arguments{ diff --git a/man/whatWQPsites.Rd b/man/whatWQPsites.Rd index 65adf0834315f97ff79c19653af3292a7260a5ba..9875d419d2af453b6710267b5b8a3340b21932ce 100644 --- a/man/whatWQPsites.Rd +++ b/man/whatWQPsites.Rd @@ -1,11 +1,8 @@ % Generated by roxygen2 (4.0.2): do not edit by hand -\name{getWQPSites} -\alias{getWQPSites} +\name{whatWQPsites} \alias{whatWQPsites} \title{Site Data Import from Water Quality Portal} \usage{ -getWQPSites(...) - whatWQPsites(...) } \arguments{