Produce an error message for deprecated behaviour

Author: boshek

R/ANNUAL_STATISTICS.R

@@ -37,6 +37,10 @@
 ANNUAL_STATISTICS <- function(hydat_path=NULL, STATION_NUMBER =NULL, PROV_TERR_STATE_LOC=NULL, 
                               start_year = "ALL", end_year = "ALL") {
 
+  if(!is.null(STATION_NUMBER) && STATION_NUMBER == "ALL"){
+    stop("Deprecated behaviour.Omit the STATION_NUMBER = \"ALL\" argument. See ?ANNUAL_STATISTICS for examples.")
+  }
+  
   if(is.null(hydat_path)){
     hydat_path = Sys.getenv("hydat")
     if(is.na(hydat_path)){

R/DLY_FLOWS.R

@@ -37,6 +37,10 @@
 
 DLY_FLOWS <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL, start_date ="ALL", end_date = "ALL") {
 
+  if(!is.null(STATION_NUMBER) && STATION_NUMBER == "ALL"){
+    stop("Deprecated behaviour.Omit the STATION_NUMBER = \"ALL\" argument. See ?DLY_FLOWS for examples.")
+  }
+  
   if(start_date == "ALL" & end_date == "ALL"){
     message("No start and end dates specified. All dates available will be returned.")
   } else {

R/DLY_LEVELS.R

@@ -35,6 +35,10 @@
 
 DLY_LEVELS <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL, start_date ="ALL", end_date = "ALL") {
 
+  if(!is.null(STATION_NUMBER) && STATION_NUMBER == "ALL"){
+    stop("Deprecated behaviour.Omit the STATION_NUMBER = \"ALL\" argument. See ?DLY_LEVELS for examples.")
+  }
+  
   if(start_date == "ALL" & end_date == "ALL"){
     message("No start and end dates specified. All dates available will be returned.")
   } else {

R/STATIONS.R

@@ -41,9 +41,9 @@
 
 STATIONS <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL) {
 
-  #if(STATION_NUMBER == "ALL" | PROV_TERR_STATE_LOC == "ALL"){
-  #  stop("Specifying ALL for STATION_NUMBER OR PROV_TERR_STATE_LOC is deprecrated. See examples for usage.")
-  #}
+  if(!is.null(STATION_NUMBER) && STATION_NUMBER == "ALL"){
+    stop("Deprecated behaviour.Omit the STATION_NUMBER = \"ALL\" argument. See ?download_realtime_dd for examples.")
+  }
 
   if(is.null(hydat_path)){
     hydat_path = Sys.getenv("hydat")

tests/testthat/test_DLY_FLOWS.R

@@ -41,3 +41,8 @@ test_that("DLY_FLOWS correctly parses leaps year",{
                             start_date = "1988-02-29" ,
                             end_date = "1988-02-29"), regexp = NA)
 })
+
+
+test_that("When DLY_FLOWS is ALL there is an error",{
+  expect_error(DLY_FLOWS(STATION_NUMBER = "ALL"))
+})

tests/testthat/test_DLY_LEVELS.R

@@ -41,3 +41,8 @@ test_that("DLY_LEVELS correctly parses leaps year",{
                             start_date = "1988-02-29" ,
                             end_date = "1988-02-29"), regexp = NA)
 })
+
+
+test_that("When DLY_LEVELS is ALL there is an error",{
+  expect_error(DLY_LEVELS(STATION_NUMBER = "ALL"))
+})