Merge pull request #28 from bcgov/formats

Formats

Author: boshek

.travis.yml

@@ -4,5 +4,5 @@ language: R
 sudo: false
 cache: packages
 
-r_build_args: "--no-build-vignettes --no-tests"
-r_check_args: "--no-build-vignettes --as-cran --no-tests --no-examples"
+r_build_args: "--no-build-vignettes"
+r_check_args: "--no-build-vignettes --as-cran --no-examples"

DESCRIPTION

@@ -1,11 +1,14 @@
 Package: tidyhydat
-Title: Extract tidy hydrometric data
-Version: 0.2.6
+Title: Extract Tidy Canadian Hydrometric Data
+Version: 0.2.7
+Date: 2017-09-12
 Authors@R: c(person("Sam", "Albers", email = "sam.albers@gov.bc.ca", role = c("aut", "cre"),
            ), person("Dave", "Hutchinson", email = "david.hutchinson@canada.ca", role = "ctb"))
-Description: tidyhydat provides functions to extract river data from Water Survey of Canada sources and make it tidy.
+Description: tidyhydat provides functions to extract river data from Water Survey of Canada sources (http://dd.weather.gc.ca/hydrometric/csv/ and http://collaboration.cmc.ec.gc.ca/cmc/hydrometrics/www/) and make it tidy.
 Depends: R (>= 3.4.0)
 License: Apache License (== 2.0) | file LICENSE
+URL: https://github.com/bcgov/tidyhydat
+BugReports: https://github.com/bcgov/tidyhydat/issues
 Encoding: UTF-8
 Imports:
     dplyr,

NEWS.md

@@ -1,3 +1,9 @@
+# tidyhydat 0.2.7
+* Updated documentation
+* Updated README
+* Created a small database so that unit testing occurs remotely (#1)
+* Fixed `STN_DATA_RANGE` bug (#26)
+
 # tidyhydat 0.2.6
 * using `styler` package to format code to tidyverse style guide
 * added `PROV_TERR_STATE_LOC` to `allstations`

R/MONTHLY_FLOWS.R

@@ -21,7 +21,7 @@
 #' @param end_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #'
 #' @return A tibble of monthly flows. This includes a \code{Date_occured} column which indicates the date of the \code{Sum_stat}. For MEAN and 
-#'   TOTAL this is not presented as those aren't daily values.
+#'   TOTAL this is not presented as those are not daily values.
 #'
 #' @examples
 #' \donttest{

R/MONTHLY_LEVELS.R

@@ -21,7 +21,7 @@
 #' @param end_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #'
 #' @return A tibble of monthly levels. This includes a \code{Date_occured} column which indicates the date of the \code{Sum_stat}. For MEAN and 
-#'   TOTAL this is not presented as those aren't daily values.
+#'   TOTAL this is not presented as those are not daily values.
 #'
 #' @examples
 #' \donttest{

R/SED_MONTHLY_LOADS.R

@@ -21,7 +21,7 @@
 #' @param end_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #'
 #' @return A tibble of monthly sediment loads. This includes a \code{Date_occured} column which indicates the date of the \code{Sum_stat}. For MEAN and 
-#'   TOTAL this is not presented as those aren't daily values.
+#'   TOTAL this is not presented as those are not daily values.
 #'
 #' @examples
 #' \donttest{

R/SED_MONTHLY_SUSCON.R

@@ -21,7 +21,7 @@
 #' @param end_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #'
 #' @return A tibble of monthly suspended sediment concentrations. This includes a \code{Date_occured} column which indicates the date of the \code{Sum_stat}. For MEAN and 
-#'   TOTAL this is not presented as those aren't daily values.
+#'   TOTAL this is not presented as those are not daily values.
 #'
 #' @examples
 #' \donttest{

R/STN_.R

@@ -32,12 +32,12 @@ STN_REMARKS <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_
   stn_remarks
 }
 
-#' STN_DATUM_CONVERTION function
+#' STN_DATUM_CONVERSION function
 #'
-#' STN_DATUM_CONVERTION look-up Table
+#' STN_DATUM_CONVERSION look-up Table
 #' @inheritParams STATIONS
 #'
-#' @return A tibble of STN_DATUM_CONVERTION
+#' @return A tibble of STN_DATUM_CONVERSION
 #'
 #' @export
 #'
@@ -88,12 +88,14 @@ STN_DATA_RANGE <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STA
     }
   }
 
-  ## Determine which stations we are querying
-  stns <- station_choice(hydat_con, STATION_NUMBER, PROV_TERR_STATE_LOC)
+  
 
   ## Read on database
   hydat_con <- DBI::dbConnect(RSQLite::SQLite(), hydat_path)
 
+  ## Determine which stations we are querying
+  stns <- station_choice(hydat_con, STATION_NUMBER, PROV_TERR_STATE_LOC)
+  
   on.exit(DBI::dbDisconnect(hydat_con))
 
   stn_data_range <- dplyr::tbl(hydat_con, "STN_DATA_RANGE") %>%
@@ -122,12 +124,12 @@ STN_DATA_RANGE <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STA
     }
   }
 
-  ## Determine which stations we are querying
-  stns <- station_choice(hydat_con, STATION_NUMBER, PROV_TERR_STATE_LOC)
-
   ## Read on database
   hydat_con <- DBI::dbConnect(RSQLite::SQLite(), hydat_path)
 
+  ## Determine which stations we are querying
+  stns <- station_choice(hydat_con, STATION_NUMBER, PROV_TERR_STATE_LOC)
+  
   on.exit(DBI::dbDisconnect(hydat_con))
 
   stn_data_range <- dplyr::tbl(hydat_con, "STN_DATA_COLLECTION") %>%

R/data.R

@@ -28,32 +28,32 @@
 #  select(STATION_NUMBER, STATION_NAME) %>%
 #  bind_rows(bcstations)
 
-#' @title A tibble of BC stations and their names
+#' A tibble of BC stations and their names
 #'
-#' @description A shorthand to avoid having always call \code{STATIONS}. Only up to date as of 2017-07-18.
+#' A shorthand to avoid having always call \code{STATIONS}. Only up to date as of 2017-07-18.
 #'
 #' @source HYDAT
 "bcstations"
 
 
-#' @title A tibble of all Canadian Stations stations and their names.
+#' A tibble of all Canadian Stations stations and their names.
 #'
-#' @description A shorthand to avoid having always call \code{STATIONS}. Only up to date as of 2017-07-18.
+#' A shorthand to avoid having always call \code{STATIONS}. Only up to date as of 2017-07-18.
 #'
 #' @source HYDAT
 "allstations"
 
 
-#' @title DATA_SYMBOLS – DATA SYMBOLS look-up table
+#' DATA SYMBOLS look-up table
 #'
-#' @description A look table for data symbols
+#' A look table for data symbols
 #'
 #' @source HYDAT
 "DATA_SYMBOLS"
 
-#' @title DATA_TYPES – DATA TYPES look-up table
+#' DATA TYPES look-up table
 #'
-#' @description A look table for data types
+#' A look table for data types
 #'
 #' @source HYDAT
 "DATA_TYPES"

R/download.R

@@ -170,9 +170,11 @@ download_realtime_dd <- function(STATION_NUMBER = NULL, PROV_TERR_STATE_LOC) {
 
 #' download a tibble of active realtime stations
 #'
-#' An up to date dataframe of all stations in the Realtime Water Survey of Canada hydrometric network operated by Environment and Cliamte Change Canada
+#' An up to date dataframe of all stations in the Realtime Water Survey of Canada 
+#'   hydrometric network operated by Environment and Climate Change Canada
 #'
-#' @param PROV_TERR_STATE_LOC Province/State/Territory or Location. See examples for list of available options. realtime_network_meta() for all stations.
+#' @param PROV_TERR_STATE_LOC Province/State/Territory or Location. See examples for list of available options. 
+#'   realtime_network_meta() for all stations.
 #'
 #' @family realtime functions
 #' @export
@@ -215,7 +217,7 @@ realtime_network_meta <- function(PROV_TERR_STATE_LOC = NULL) {
 #' Request a token from the Environment and Climate Change Canada
 #' @param username Supplied by ECCC
 #' @param password Supplied by ECCC
-#' Request a token from the ECCC webservice using the POST method. This token expires after 10 minutes.
+#' Request a token from the ECCC web service using the POST method. This token expires after 10 minutes.
 #' You can only have 5 tokens out at once.
 #'
 #' @details The \code{username} and \code{password} should be treated carefully and should never be entered directly into an r script or console.
@@ -238,13 +240,13 @@ get_ws_token <- function(username, password) {
   r <- httr::POST("https://wateroffice.ec.gc.ca/services/auth", body = login)
 
   ## If the POST request was not a successful, print out why.
-  ## Possibly could provide errors as per Webservice guidelines
+  ## Possibly could provide errors as per web service guidelines
   if (httr::status_code(r) == 422) {
     stop("422 Unprocessable Entity: Username and/or password are missing or are formatted incorrectly.")
   }
 
   if (httr::status_code(r) == 403) {
-    stop("403 Forbidden: the webservice is denying your request. Try any of the following options: ensure you are not currently using all 5 tokens, 
+    stop("403 Forbidden: the web service is denying your request. Try any of the following options: ensure you are not currently using all 5 tokens, 
          wait a few minutes and try again or copy the get_ws_token code and paste it directly into the console.")
   }
 
@@ -260,7 +262,7 @@ get_ws_token <- function(username, password) {
 }
 
 #' Download realtime data from the ECCC web service
-#' Function to actually retrieve data from ECCC webservice. Before using this function,
+#' Function to actually retrieve data from ECCC web service. Before using this function,
 #' a token from \code{get_ws_token()} is needed.
 #' @param STATION_NUMBER Water Survey of Canada station number.
 #' @param parameters parameter ID. Can take multiple entries. Parameter is a numeric code. See \code{param_id} for options. Defaults to all parameters.
@@ -330,7 +332,7 @@ download_realtime_ws <- function(STATION_NUMBER, parameters = c(46, 16, 52, 47,
   get_ws <- httr::GET(url_for_GET)
 
   if (httr::status_code(get_ws) == 403) {
-    stop("403 Forbidden: the webservice is denying your request. Try any of the following options: wait a few minutes and try 
+    stop("403 Forbidden: the web service is denying your request. Try any of the following options: wait a few minutes and try 
          again or copy the get_ws_token code and paste it directly into the console.")
   }
 

R/tidyhydat.R

@@ -41,9 +41,10 @@
 #'  \item tidy data vignette: \url{https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html}
 #'  }
 #'
-#'  To download the latest version of hydat please follow this link:
+#'  To download the latest version of hydat please either:
 #'  \itemize{
-#'   \item \url{http://collaboration.cmc.ec.gc.ca/cmc/hydrometrics/www/}
+#'   \item Follow this link \url{http://collaboration.cmc.ec.gc.ca/cmc/hydrometrics/www/} or;
+#'   \item use the \code{download_hydat()} function.
 #'   }
 #'   
 #'

R/utils.R

@@ -40,7 +40,7 @@ search_number <- function(search_term) {
 
 #' AGENCY_LIST function
 #'
-#' AGENCY_LIST – AGENCY look-up Table
+#' AGENCY look-up Table
 #' @param hydat_path Directory to the hydat database. Can be set as "Hydat.sqlite3" which will look for Hydat in the working directory.
 #' The hydat path can also be set in the \code{.Renviron} file so that it doesn't have to specified every function call. The path should
 #' set as the variable \code{hydat}. Open the \code{.Renviron} file using this command: \code{file.edit("~/.Renviron")}.
@@ -74,7 +74,7 @@ AGENCY_LIST <- function(hydat_path=NULL) {
 
 #'  REGIONAL_OFFICE_LIST function
 #'
-#'  REGIONAL_OFFICE_LIST – OFFICE look-up Table
+#'  OFFICE look-up Table
 #' @inheritParams AGENCY_LIST
 #' @return A tibble of offices
 #'
@@ -106,7 +106,7 @@ REGIONAL_OFFICE_LIST <- function(hydat_path=NULL) {
 
 #'  DATUM_LIST function
 #'
-#'  DATUM_LIST – DATUM look-up Table
+#'  DATUM look-up Table
 #' @inheritParams AGENCY_LIST
 #'
 #' @return A tibble of DATUMS