update documentation to tidy style. Closes #19

Author: boshek

R/ANNUAL_INSTANT_PEAKS.R

@@ -11,11 +11,11 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 
-#' @title Annual maximum/minimum instantaneous flows and water levels
-#'
-#' @description Provides wrapper to turn the ANNUAL_INSTANT_PEAKS table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
-#' \code{PROV_TERR_STATE_LOC} can both be supplied. If both are omitted all values from the \code{STATIONS} table are returned.
+#' Annual maximum/minimum instantaneous flows and water levels
 #'
+#' Provides wrapper to turn the ANNUAL_INSTANT_PEAKS table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
+#' \code{PROV_TERR_STATE_LOC} can both be supplied. 
+#' 
 #' @inheritParams STATIONS
 #' @param start_year First year of the returned record
 #' @param end_year Last year of the returned record
@@ -30,7 +30,9 @@
 #' ## Multiple province, station number not specified
 #' ANNUAL_INSTANT_PEAKS(PROV_TERR_STATE_LOC = c("AB","YT"), hydat_path = "H:/Hydat.sqlite3")
 #' }
-#'
+#' 
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 #'
 ANNUAL_INSTANT_PEAKS <- function(hydat_path, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL,

R/ANNUAL_STATISTICS.R

@@ -11,11 +11,10 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 
-#' @title Extract daily flows information from the HYDAT database
+#' Extract annual statistics information from the HYDAT database
 #'
-#' @description Provides wrapper to turn the ANNUAL_STATISTICS table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
-#' \code{PROV_TERR_STATE_LOC} must both be supplied. When STATION_NUMBER="ALL" the PROV_TERR_STATE_LOC argument decides
-#' where those stations come from.
+#' Provides wrapper to turn the ANNUAL_STATISTICS table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
+#'   \code{PROV_TERR_STATE_LOC} must both be supplied. 
 #'
 #' @inheritParams STATIONS
 #' @param start_year First year of the returned record
@@ -25,13 +24,15 @@
 #'
 #' @examples
 #' \donttest{
-#' ## Multiple stations province not specified
-#' ANNUAL_STATISTICS(STATION_NUMBER = c("08NM083","05AE027"), hydat_path = "H:/Hydat.sqlite3")
-#'
-#' ## Multiple province, station number not specified
-#' ANNUAL_STATISTICS(PROV_TERR_STATE_LOC = c("AB","SK"), hydat_path = "H:/Hydat.sqlite3")
+#'   ## Multiple stations province not specified
+#'   ANNUAL_STATISTICS(STATION_NUMBER = c("08NM083","05AE027"), hydat_path = "H:/Hydat.sqlite3")
+#'  
+#'   ## Multiple province, station number not specified
+#'   ANNUAL_STATISTICS(PROV_TERR_STATE_LOC = c("AB","SK"), hydat_path = "H:/Hydat.sqlite3")
 #' }
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 ANNUAL_STATISTICS <- function(hydat_path=NULL, STATION_NUMBER =NULL, PROV_TERR_STATE_LOC=NULL,

R/DLY_FLOWS.R

@@ -31,6 +31,8 @@
 #'
 #'           }
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 

R/DLY_LEVELS.R

@@ -29,6 +29,8 @@
 #'
 #'           }
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 

R/SED_DLY_LOAD.R

@@ -10,17 +10,17 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 
-#' @title Extract daily sediment load information from the HYDAT database
+#' Extract daily sediment load information from the HYDAT database
 #'
-#' @description Provides wrapper to turn the SED_DLY_LOADS table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
+#' Provides wrapper to turn the SED_DLY_LOADS table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
 #' \code{PROV_TERR_STATE_LOC} can both be supplied. If both are omitted all values from the \code{STATIONS} table are returned.
 #' That is a large vector for \code{SED_DLY_LOADS}.
 #'
 #' @inheritParams STATIONS
 #' @param start_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #' @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 daily suspended sediment concentration (mg/l)
+#' @return A tibble of daily suspended sediment loads (tonnes)
 #'
 #' @examples
 #' \donttest{
@@ -31,6 +31,8 @@
 #'
 #'           }
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 

R/SED_DLY_SUSCON.R

@@ -10,9 +10,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 
-#' @title Extract daily suspended sediment concentration information from the HYDAT database
+#' Extract daily suspended sediment concentration information from the HYDAT database
 #'
-#' @description Provides wrapper to turn the SED_DLY_SUSCON table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
+#' Provides wrapper to turn the SED_DLY_SUSCON table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
 #' \code{PROV_TERR_STATE_LOC} can both be supplied. If both are omitted all values from the \code{STATIONS} table are returned.
 #' That is a large vector for \code{SED_DLY_SUSCON}.
 #'
@@ -31,6 +31,8 @@
 #'
 #'           }
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 

R/SED_MONTHLY_LOADS.R

@@ -20,7 +20,7 @@
 #' @param start_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #' @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 
+#' @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.
 #'
 #' @examples

R/SED_MONTHLY_SUSCON.R

@@ -20,7 +20,7 @@
 #' @param start_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #' @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 
+#' @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.
 #'
 #' @examples

R/SED_SAMPLES.R

@@ -10,17 +10,17 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 
-#' @title Extract instantaneous sediment sample information from the HYDAT database
+#' Extract instantaneous sediment sample information from the HYDAT database
 #'
-#' @description Provides wrapper to turn the SED_SAMPLES table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
+#' Provides wrapper to turn the SED_SAMPLES table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
 #' \code{PROV_TERR_STATE_LOC} can both be supplied. If both are omitted all values from the \code{STATIONS} table are returned.
 #' That is a large vector for \code{SED_SAMPLES}.
 #'
 #' @inheritParams STATIONS
 #' @param start_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #' @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 daily suspended sediment concentration (mg/l)
+#' @return A tibble of instantaneous sediment samples data
 #'
 #' @examples
 #' \donttest{
@@ -31,6 +31,8 @@
 #'
 #'           }
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 

R/SED_SAMPLES_PSD.R

@@ -10,17 +10,17 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 
-#' @title Extract instantaneous sediment sample information from the HYDAT database
+#' Extract instantaneous sediment sample information from the HYDAT database
 #'
-#' @description Provides wrapper to turn the SED_SAMPLES_PSD table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
+#' Provides wrapper to turn the SED_SAMPLES_PSD table in HYDAT into a tidy data frame.  \code{STATION_NUMBER} and
 #' \code{PROV_TERR_STATE_LOC} can both be supplied. If both are omitted all values from the \code{STATIONS} table are returned.
 #' That is a large vector for \code{SED_SAMPLES_PSD}.
 #'
 #' @inheritParams STATIONS
 #' @param start_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
 #' @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 daily suspended sediment concentration (mg/l)
+#' @return A tibble of sediment sample particle size data
 #'
 #' @examples
 #' \donttest{
@@ -31,6 +31,8 @@
 #'
 #'           }
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 

R/STATIONS.R

@@ -12,18 +12,16 @@
 
 
 
-#' @title Extract station information from the HYDAT database
+#' Extract station information from the HYDAT database
 #'
-#' @description Provides wrapper to turn the STATIONS table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
+#' Provides wrapper to turn the STATIONS table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
 #' \code{PROV_TERR_STATE_LOC} can both be supplied. If both are omitted all values from the \code{STATIONS} table are returned
 #'
-#' @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")}.
-#' @param STATION_NUMBER Water Survey of Canada station number. If this argument is omitted from the function call, the value of \code{PROV_TERR_STATE_LOC}
+#' @inheritParams AGENCY_LIST
+#' @param STATION_NUMBER Water Survey of Canada station number. If this argument is omitted, the value of \code{PROV_TERR_STATE_LOC}
 #' is returned.
-#' @param PROV_TERR_STATE_LOC Province, state or territory. If this argument is omitted from the function call, the value of \code{STATION_NUMBER}
-#' is returned. See \code{unique(STATIONS(hydat_path = "H:/Hydat.sqlite3")$PROV_TERR_STATE_LOC)}
+#' @param PROV_TERR_STATE_LOC Province, state or territory. If this argument is omitted, the value of \code{STATION_NUMBER}
+#' is returned. See \code{unique(allstations$PROV_TERR_STATE_LOC)}
 #'
 #' @return A tibble of stations and associated metadata
 #'
@@ -37,6 +35,8 @@
 #' }
 #'
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 STATIONS <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL) {

R/STN_.R

@@ -1,6 +1,6 @@
-#' @title STN_REMARKS function
+#' STN_REMARKS function
 #'
-#' @description STN_REMARKS look-up Table
+#' STN_REMARKS look-up Table
 #' @inheritParams STATIONS
 #'
 #' @return A tibble of STN_REMARKS
@@ -32,9 +32,9 @@ STN_REMARKS <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_
   stn_remarks
 }
 
-#' @title STN_DATUM_CONVERTION function
+#' STN_DATUM_CONVERTION function
 #'
-#' @description STN_DATUM_CONVERTION look-up Table
+#' STN_DATUM_CONVERTION look-up Table
 #' @inheritParams STATIONS
 #'
 #' @return A tibble of STN_DATUM_CONVERTION
@@ -69,13 +69,15 @@ STN_DATUM_CONVERSION <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TE
   stn_datum_conversion
 }
 
-#' @title STN_DATA_RANGE function
+#' STN_DATA_RANGE function
 #'
-#' @description STN_DATA_RANGE look-up Table
+#' STN_DATA_RANGE look-up Table
 #' @inheritParams STATIONS
 #'
 #' @return A tibble of STN_DATA_RANGE
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 #'
 STN_DATA_RANGE <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL) {
@@ -101,13 +103,15 @@ STN_DATA_RANGE <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STA
   stn_data_range
 }
 
-#' @title STN_DATA_COLLECTION function
+#' STN_DATA_COLLECTION function
 #'
-#' @description STN_DATA_COLLECTION look-up Table
+#' STN_DATA_COLLECTION look-up Table
 #' @inheritParams STATIONS
 #'
 #' @return A tibble of STN_DATA_COLLECTION
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 #'
 STN_DATA_RANGE <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL) {
@@ -140,13 +144,15 @@ STN_DATA_RANGE <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STA
 }
 
 
-#' @title STN_OPERATION_SCHEDULE function
+#' STN_OPERATION_SCHEDULE function
 #'
-#' @description STN_OPERATION_SCHEDULE look-up Table
+#' STN_OPERATION_SCHEDULE look-up Table
 #' @inheritParams STATIONS
 #'
 #' @return A tibble of STN_OPERATION_SCHEDULE
 #'
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 #'
 STN_OPERATION_SCHEDULE <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL) {

R/STN_REGULATION.R

@@ -12,9 +12,9 @@
 
 
 
-#' @title Extract station regulation from the HYDAT database
+#' Extract station regulation from the HYDAT database
 #'
-#' @description Provides wrapper to turn the STN_REGULATION table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
+#' Provides wrapper to turn the STN_REGULATION table in HYDAT into a tidy data frame. \code{STATION_NUMBER} and
 #' \code{PROV_TERR_STATE_LOC} can both be supplied. If both are omitted all values from the \code{STATIONS} table are returned
 #'
 #' @inheritParams STATIONS
@@ -31,6 +31,8 @@
 #' }
 #'
 
+#' @family HYDAT functions
+#' @source HYDAT
 #' @export
 
 STN_REGULATION <- function(hydat_path=NULL, STATION_NUMBER = NULL, PROV_TERR_STATE_LOC = NULL) {