Commit 70e22e99 authored by Laura A DeCicco's avatar Laura A DeCicco
Browse files

Updating news and help. Removing old functions.

parent fea047e9
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 dataRetrieval 2.0.0
=========== ===========
* Overhaul of function names based on initial user feedback * Overhaul of function names based on initial user feedback
......
#' @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(...)
}
...@@ -18,35 +18,29 @@ Web service retrieval functions: ...@@ -18,35 +18,29 @@ Web service retrieval functions:
|Function | Inputs | Description | |Function | Inputs | Description |
| -------------| ------------------------|:-------------| | -------------| ------------------------|:-------------|
|`readNWISdata` | `...`, service | NWIS data using user-specified queries | |`readNWISdata` | `...`, `service` | NWIS data using user-specified queries |
|`readNWISdv` | `Common 3`, parameter code, statCd | NWIS daily data with `Common` query | |`readNWISdv` | `Common 3`, `parameterCd`, `statCd` | NWIS daily data with `Common` query |
|`readNWISqw` | `Common 3`, parameter code, expanded | NWIS water quality data with `Common` query | |`readNWISqw` | `Common 3`, `parameterCd`, `expanded` | NWIS water quality data with `Common` query |
|`readNWISuv` | `Common 3`, parameter code | NWIS instantaneous data with `Common` query | |`readNWISuv` | `Common 3`, `parameterCd` | NWIS instantaneous data with `Common` query |
|`readNWISpCode` | parameterCd | NWIS parameter code information | |`readNWISpCode` | `parameterCd` | NWIS parameter code information |
|`readNWISgwl` | `Common 3` | NWIS groundwater level data with `Common` query | |`readNWISgwl` | `Common 3` | NWIS groundwater level data with `Common` query |
|`readNWISpeak` | `Common 3` | NWIS peak flow 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 | |`readNWISmeas` | `Common 3` | NWIS surface-water measurement data with `Common` query |
|`readNWISrating` | siteNumber, type | NWIS rating table for an active USGS streamgage | |`readNWISrating` | `siteNumber`, type | NWIS rating table for an active USGS streamgage |
|`readNWISsite` | siteNumber | NWIS site information | |`readNWISsite` | `siteNumber` | NWIS site information |
|`whatNWISsites` | `...` | NWIS site search using user-specified queries | |`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 | |`readWQPdata` | `...` | WQP data using user-specified queries |
|`readWQPqw` | `Common 3` | WQP data with `Common 3` query and either parameter code or characteristic name| |`readWQPqw` | `Common 3` | WQP data with `Common 3` query and either parameter code or characteristic name|
|`whatWQPsites` | `...` | WQP site search using user-specified queries | |`whatWQPsites` | `...` | WQP site search using user-specified queries |
* `Common 3` = siteNumber, startDate, endDate * `Common 3` = siteNumber, startDate, endDate
Moving `EGRET` specific functions to `EGRET` (version 2.0.0 and greater): ##Reporting bugs
|Information Source | Meta Data | Data | Please consider reporting bugs and asking questions on the Issues page:
| -------------| -------------| ------------- |:-------------|
|NWIS | `readNWISInfo` | `readNWISSample` |
| | | `readNWISDaily` |
| Water Quality Portal | `readWQPInfo`| `readWQPSample` |
| User-supplied files | `readUserInfo` | `readUserDaily`|
| | | `readUserSample` |
[https://github.com/USGS-R/dataRetrieval/issues](https://github.com/USGS-R/dataRetrieval/issues)
##Subscribe ##Subscribe
...@@ -55,11 +49,7 @@ egret_comments@usgs.gov ...@@ -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. 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 ##Package Installation
To install the dataRetrieval package, you must be using R 3.0 or greater and run the following command: To install the dataRetrieval package, you must be using R 3.0 or greater and run the following command:
...@@ -72,7 +62,19 @@ To install the dataRetrieval package, you must be using R 3.0 or greater and run ...@@ -72,7 +62,19 @@ To install the dataRetrieval package, you must be using R 3.0 or greater and run
###dataRetrieval 2.0.0 ###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 back WaterML2 parsing tool
* Added specific groundwater, rating, peak, and surfacewater measurement functions * Added specific groundwater, rating, peak, and surfacewater measurement functions
* Attached metadata attributes to returned dataframes * Attached metadata attributes to returned dataframes
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment