diff --git a/R/available-classes.R b/R/available-classes.R index a55db1e..7698971 100644 --- a/R/available-classes.R +++ b/R/available-classes.R @@ -101,12 +101,10 @@ print_station_coverage <- function(x) { #' @param ... ignored #' #' @return A tibble with columns: -#' \itemize{ -#' \item STATION_NUMBER -#' \item final_start, final_end - date range for validated data -#' \item provisional_start, provisional_end - date range for provisional data -#' \item final_n, provisional_n - record counts -#' } +#' - STATION_NUMBER +#' - final_start, final_end - date range for validated data +#' - provisional_start, provisional_end - date range for provisional data +#' - final_n, provisional_n - record counts #' #' @method summary available #' @export diff --git a/R/available.R b/R/available.R index 3ee20a7..24f2494 100644 --- a/R/available.R +++ b/R/available.R @@ -46,7 +46,7 @@ #' ## Data Approval Status #' #' The `Approval` column uses ECCC's terminology -#' (see \url{https://wateroffice.ec.gc.ca/contactus/faq_e.html}): +#' (see ): #' #' - **"final"**: Historical data from HYDAT or web service that has been approved by ECCC. #' @@ -60,14 +60,12 @@ #' sources and query metadata. #' #' @format A tibble with 6 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date. Formatted as a Date class.} -#' \item{Parameter}{Parameter being measured. Value is "Flow"} -#' \item{Value}{Discharge value. The units are m^3/s.} -#' \item{Symbol}{Measurement/river conditions} -#' \item{Approval}{Approval status: "final" (approved) or "provisional" (subject to revision)} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date. Formatted as a Date class. +#' - **Parameter**: Parameter being measured. Value is "Flow" +#' - **Value**: Discharge value. The units are m^3/s. +#' - **Symbol**: Measurement/river conditions +#' - **Approval**: Approval status: "final" (approved) or "provisional" (subject to revision) #' #' @examples #' \dontrun{ @@ -141,7 +139,7 @@ available_flows <- function( #' ## Data Approval Status #' #' The `Approval` column uses ECCC's terminology -#' (see \url{https://wateroffice.ec.gc.ca/contactus/faq_e.html}): +#' (see ): #' #' - **"final"**: Historical data from HYDAT or web service that has been approved by ECCC. #' @@ -154,14 +152,12 @@ available_flows <- function( #' sources and query metadata. #' #' @format A tibble with 6 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date. Formatted as a Date class.} -#' \item{Parameter}{Parameter being measured. Value is "Level"} -#' \item{Value}{Level value. The units are metres.} -#' \item{Symbol}{Measurement/river conditions} -#' \item{Approval}{Approval status: "final" (approved) or "provisional" (subject to revision)} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date. Formatted as a Date class. +#' - **Parameter**: Parameter being measured. Value is "Level" +#' - **Value**: Level value. The units are metres. +#' - **Symbol**: Measurement/river conditions +#' - **Approval**: Approval status: "final" (approved) or "provisional" (subject to revision) #' #' @examples #' \dontrun{ diff --git a/R/data.R b/R/data.R index b30eb45..2a1b95e 100644 --- a/R/data.R +++ b/R/data.R @@ -17,18 +17,16 @@ #' #' #' @format A tibble with 5 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{STATION_NAME}{Official name for station identification} -#' \item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -#' \item{HYD_STATUS}{Current status of discharge or level monitoring in the hydrometric network} -#' \item{REAL_TIME}{Logical. Indicates if a station has the capacity to deliver data in -#' real-time or near real-time} -#' \item{LATITUDE}{North-South Coordinates of the gauging station in decimal degrees} -#' \item{LONGITUDE}{East-West Coordinates of the gauging station in decimal degrees} -#' \item{station_tz}{Timezone of station calculated using the lutz package based on LAT/LONG of stations} -#' \item{standard_offset}{Offset from UTC of local standard time} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **STATION_NAME**: Official name for station identification +#' - **PROV_TERR_STATE_LOC**: The province, territory or state in which the station is located +#' - **HYD_STATUS**: Current status of discharge or level monitoring in the hydrometric network +#' - **REAL_TIME**: Logical. Indicates if a station has the capacity to deliver data in +#' real-time or near real-time +#' - **LATITUDE**: North-South Coordinates of the gauging station in decimal degrees +#' - **LONGITUDE**: East-West Coordinates of the gauging station in decimal degrees +#' - **station_tz**: Timezone of station calculated using the lutz package based on LAT/LONG of stations +#' - **standard_offset**: Offset from UTC of local standard time #' #' @source HYDAT, Meteorological Service of Canada datamart "allstations" @@ -38,11 +36,9 @@ #' A look table for data symbols #' #' @format A tibble with 5 rows and 3 variables: -#' \describe{ -#' \item{SYMBOL_ID}{Symbol code} -#' \item{SYMBOL_EN}{Description of Symbol (English)} -#' \item{SYMBOL_FR}{Description of Symbol (French)} -#' } +#' - **SYMBOL_ID**: Symbol code +#' - **SYMBOL_EN**: Description of Symbol (English) +#' - **SYMBOL_FR**: Description of Symbol (French) #' @family HYDAT functions #' @source HYDAT "hy_data_symbols" @@ -52,28 +48,24 @@ #' A look table for data types #' #' @format A tibble with 5 rows and 3 variables: -#' \describe{ -#' \item{DATA_TYPE}{Data type code} -#' \item{DATA_TYPE_EN}{Descriptive data type (English)} -#' \item{DATA_TYPE_FR}{Descriptive data type (French)} -#' } +#' - **DATA_TYPE**: Data type code +#' - **DATA_TYPE_EN**: Descriptive data type (English) +#' - **DATA_TYPE_FR**: Descriptive data type (French) #' @family HYDAT functions #' #' @source HYDAT "hy_data_types" -#' @title Parameter ID +#' Parameter ID #' -#' @description A tibble of parameter id codes and their corresponding explanation/description specific to the ECCC webservice +#' A tibble of parameter id codes and their corresponding explanation/description specific to the ECCC webservice #' #' @format A tibble with 8 rows and 7 variables: -#' \describe{ -#' \item{Parameter}{Numeric parameter code} -#' \item{Code}{Letter parameter code} -#' \item{Name_En}{Code name in English} -#' \item{Name_En}{Code name in French} -#' \item{Unit}{Parameter units} -#' } +#' - **Parameter**: Numeric parameter code +#' - **Code**: Letter parameter code +#' - **Name_En**: Code name in English +#' - **Name_En**: Code name in French +#' - **Unit**: Parameter units #' #' #' diff --git a/R/download.R b/R/download.R index 00c6552..30bbaa1 100644 --- a/R/download.R +++ b/R/download.R @@ -19,7 +19,7 @@ #' @param dl_hydat_here Directory to the HYDAT database. The path is chosen by the `rappdirs` package and is OS specific and can be view by [hy_dir()]. #' This path is also supplied automatically to any function that uses the HYDAT database. A user specified path can be set though this is not the advised approach. #' It also downloads the database to a directory specified by [hy_dir()]. -#' @param ask Whether to ask (as \code{TRUE}/\code{FALSE}) if HYDAT should be downloaded. If \code{FALSE} the keypress question is skipped. +#' @param ask Whether to ask (as `TRUE`/`FALSE`) if HYDAT should be downloaded. If `FALSE` the keypress question is skipped. #' @export #' #' @examples \dontrun{ diff --git a/R/hy.R b/R/hy.R index 0934d5f..61132a7 100644 --- a/R/hy.R +++ b/R/hy.R @@ -6,12 +6,10 @@ #' @return A tibble of hy_stn_remarks #' #' @format A tibble with 4 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{REMARK_TYPE}{Type of Remark} -#' \item{Year}{Year of the remark} -#' \item{REMARK}{Remark} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **REMARK_TYPE**: Type of Remark +#' - **Year**: Year of the remark +#' - **REMARK**: Remark #' #' @export #' @@ -69,13 +67,11 @@ hy_stn_remarks <- function( #' @return A tibble of hy_stn_datum_conv #' #' @format A tibble with 4 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{DATUM_FROM}{Identifying a datum from which water level is being converted} -#' \item{DATUM_TO}{Identifying a datum to which water level is being converted} -#' \item{CONVERSTION_FACTOR}{The conversion factor applied to water levels referred to -#' one datum to obtain water levels referred to another datum} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **DATUM_FROM**: Identifying a datum from which water level is being converted +#' - **DATUM_TO**: Identifying a datum to which water level is being converted +#' - **CONVERSTION_FACTOR**: The conversion factor applied to water levels referred to +#' one datum to obtain water levels referred to another datum #' #' #' @export @@ -149,12 +145,10 @@ hy_stn_datum_conv <- function( #' @return A tibble of hy_stn_datum_unrelated #' #' @format A tibble with 4 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{DATUM_ID}{Unique code identifying a datum} -#' \item{Year_from}{First year of use} -#' \item{Year_to}{Last year of use} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **DATUM_ID**: Unique code identifying a datum +#' - **Year_from**: First year of use +#' - **Year_to**: Last year of use #' #' @export #' @examples @@ -214,14 +208,12 @@ hy_stn_datum_unrelated <- function( #' @return A tibble of hy_stn_data_range #' #' @format A tibble with 6 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{DATA_TYPE}{Code for the type of data} -#' \item{SED_DATA_TYPE}{Code for the type of instantaneous sediment data} -#' \item{Year_from}{First year of use} -#' \item{Year_to}{Last year of use} -#' \item{RECORD_LENGTH}{Number of years of data available in the HYDAT database} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **DATA_TYPE**: Code for the type of data +#' - **SED_DATA_TYPE**: Code for the type of instantaneous sediment data +#' - **Year_from**: First year of use +#' - **Year_to**: Last year of use +#' - **RECORD_LENGTH**: Number of years of data available in the HYDAT database #' #' @family HYDAT functions #' @source HYDAT @@ -281,16 +273,14 @@ hy_stn_data_range <- function( #' @return A tibble of hy_stn_data_coll #' #' @format A tibble with 6 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{DATA_TYPE}{The type of data} -#' \item{Year_from}{First year of use} -#' \item{Year_to}{Last year of use} -#' \item{MEASUREMENT}{The sampling method used in the collection of -#' sediment data or the type of the gauge used in the collection of the hydrometric data} -#' \item{OPERATION}{The schedule of station operation -#' for the collection of sediment or hydrometric data} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **DATA_TYPE**: The type of data +#' - **Year_from**: First year of use +#' - **Year_to**: Last year of use +#' - **MEASUREMENT**: The sampling method used in the collection of +#' sediment data or the type of the gauge used in the collection of the hydrometric data +#' - **OPERATION**: The schedule of station operation +#' for the collection of sediment or hydrometric data #' #' @family HYDAT functions #' @source HYDAT @@ -363,13 +353,11 @@ hy_stn_data_coll <- function( #' @return A tibble of hy_stn_op_schedule #' #' @format A tibble with 6 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{DATA_TYPE}{The type of data} -#' \item{Year}{Year of operation schedule} -#' \item{Month_from}{First month of use} -#' \item{Month_to}{Last month of use} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **DATA_TYPE**: The type of data +#' - **Year**: Year of operation schedule +#' - **Month_from**: First month of use +#' - **Month_to**: Last month of use #' #' @family HYDAT functions #' @source HYDAT @@ -424,11 +412,11 @@ hy_stn_op_schedule <- function( as.hy(stn_operation_schedule) } -#' @title Output OS-independent path to the HYDAT sqlite database +#' Output OS-independent path to the HYDAT sqlite database #' -#' @description Provides the download location for \link{download_hydat} in an OS independent manner. +#' Provides the download location for [download_hydat] in an OS independent manner. #' -#' @param ... arguments potentially passed to \code{rappdirs::user_data_dir} +#' @param ... arguments potentially passed to `rappdirs::user_data_dir` #' #' @examples \dontrun{ #' hy_dir() @@ -448,8 +436,8 @@ hy_dir <- function(...) { #' AGENCY look-up Table #' #' @param hydat_path The path to the hydat database or NULL to use the default location -#' used by \link{download_hydat}. It is also possible to pass in an existing -#' \link[dplyr]{src_sqlite} such that the database only needs to be opened once per +#' used by [download_hydat]. It is also possible to pass in an existing +#' [src_sqlite][dplyr::src_sqlite] such that the database only needs to be opened once per #' user-level call. #' #' @return A tibble of agencies diff --git a/R/hy_annual_stats.R b/R/hy_annual_stats.R index a4f35d0..1dcb001 100644 --- a/R/hy_annual_stats.R +++ b/R/hy_annual_stats.R @@ -22,17 +22,15 @@ #' @return A tibble of hy_annual_stats. #' #' @format A tibble with 8 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Parameter}{Parameter being measured. Only possible values are FLOW and LEVEL} -#' \item{Year}{Year of record.} -#' \item{Sum_stat}{Summary statistic being used.} -#' \item{Value}{Value of the measurement. If Parameter equals FLOW the units are m^3/s. If Parameter equals LEVEL the -#' units are metres.} -#' \item{Date}{Observation date. Formatted as a Date class. MEAN is a annual summary -#' and therefore has an NA value for Date.} -#' \item{Symbol}{Measurement/river conditions} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Parameter**: Parameter being measured. Only possible values are FLOW and LEVEL +#' - **Year**: Year of record. +#' - **Sum_stat**: Summary statistic being used. +#' - **Value**: Value of the measurement. If Parameter equals FLOW the units are m^3/s. If Parameter equals LEVEL the +#' units are metres. +#' - **Date**: Observation date. Formatted as a Date class. MEAN is a annual summary +#' and therefore has an NA value for Date. +#' - **Symbol**: Measurement/river conditions #' #' @examples #' \dontrun{ diff --git a/R/hy_daily.R b/R/hy_daily.R index c639602..2b8e62f 100644 --- a/R/hy_daily.R +++ b/R/hy_daily.R @@ -21,13 +21,11 @@ #' @return A tibble of daily flows and levels #' #' @format A tibble with 5 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date. Formatted as a Date class.} -#' \item{Parameter}{Parameter being measured.} -#' \item{Value}{Discharge value. The units are m^3/s.} -#' \item{Symbol}{Measurement/river conditions} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date. Formatted as a Date class. +#' - **Parameter**: Parameter being measured. +#' - **Value**: Discharge value. The units are m^3/s. +#' - **Symbol**: Measurement/river conditions #' #' @export #' @family HYDAT functions diff --git a/R/hy_daily_flows.R b/R/hy_daily_flows.R index c048fe6..93862d8 100644 --- a/R/hy_daily_flows.R +++ b/R/hy_daily_flows.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 flows information from HYDAT database or web service +#' Extract daily flows information from HYDAT database or web service #' -#' @description Provides wrapper to turn the DLY_FLOWS table in HYDAT (or historical web service) +#' Provides wrapper to turn the DLY_FLOWS table in HYDAT (or historical web service) #' into a tidy data frame of daily flows. `station_number` and `prov_terr_state_loc` can both be #' supplied. If both are omitted all values from the `hy_stations` table are returned. #' That is a large tibble for `hy_daily_flows`. @@ -32,13 +32,11 @@ #' @return A tibble of daily flows #' #' @format A tibble with 5 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date. Formatted as a Date class.} -#' \item{Parameter}{Parameter being measured. Only possible value is Flow} -#' \item{Value}{Discharge value. The units are m^3/s.} -#' \item{Symbol}{Measurement/river conditions} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date. Formatted as a Date class. +#' - **Parameter**: Parameter being measured. Only possible value is Flow +#' - **Value**: Discharge value. The units are m^3/s. +#' - **Symbol**: Measurement/river conditions #' #' @examples #' \dontrun{ diff --git a/R/hy_daily_levels.R b/R/hy_daily_levels.R index 64655b9..9884df2 100644 --- a/R/hy_daily_levels.R +++ b/R/hy_daily_levels.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 levels information from HYDAT database or web service +#' Extract daily levels information from HYDAT database or web service #' -#' @description Provides wrapper to turn the DLY_LEVELS table in HYDAT (or historical web service) +#' Provides wrapper to turn the DLY_LEVELS table in HYDAT (or historical web service) #' into a tidy data frame. The primary value returned by this function is water level. #' `station_number` and `prov_terr_state_loc` can both be supplied. If both are omitted all #' values from the `hy_stations` table are returned. That is a large vector for `hy_daily_levels`. @@ -28,13 +28,11 @@ #' @return A tibble of daily levels #' #' @format A tibble with 5 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date. Formatted as a Date class.} -#' \item{Parameter}{Parameter being measured. Only possible value is Level} -#' \item{Value}{Level value. The units are metres.} -#' \item{Symbol}{Measurement/river conditions} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date. Formatted as a Date class. +#' - **Parameter**: Parameter being measured. Only possible value is Level +#' - **Value**: Level value. The units are metres. +#' - **Symbol**: Measurement/river conditions #' #' @examples #' \dontrun{ diff --git a/R/hy_db.R b/R/hy_db.R index 877b36d..bd4c280 100644 --- a/R/hy_db.R +++ b/R/hy_db.R @@ -76,17 +76,17 @@ hy_src_disconnect <- function(src) { #' Get the location of the HYDAT database #' -#' The full HYDAT database needs to be downloaded from \link{download_hydat}, but for testing +#' The full HYDAT database needs to be downloaded from [download_hydat], but for testing #' purposes, a small test database is included in this package. Use -#' \code{hydat_path = hy_test_db()} in hy_* functions to explicitly use the test database; -#' use \code{hydat_path = hy_downloaded_db()} to explicitly use the full, most recent -#' downloaded database (this is also the path returned by \code{hy_default_db()}). +#' `hydat_path = hy_test_db()` in hy_* functions to explicitly use the test database; +#' use `hydat_path = hy_downloaded_db()` to explicitly use the full, most recent +#' downloaded database (this is also the path returned by `hy_default_db()`). #' #' @return The file location of a HYDAT database. #' @export #' #' @seealso -#' \link{hy_src}, \link{hy_set_default_db}. +#' [hy_src], [hy_set_default_db]. #' #' @examples #' \dontrun{ @@ -123,9 +123,9 @@ hy_default_db <- function() { #' reproducibility purposes, store hydat somewhere other than hy_dir(). #' #' @param hydat_path The path to the a HYDAT sqlite3 database file -#' (e.g., \link{hy_test_db}) +#' (e.g., [hy_test_db]) #' -#' @return returns the previous value of \link{hy_default_db}. +#' @return returns the previous value of [hy_default_db]. #' @export #' #' @examples diff --git a/R/hy_monthly_flows.R b/R/hy_monthly_flows.R index 39264e1..1a640a2 100644 --- a/R/hy_monthly_flows.R +++ b/R/hy_monthly_flows.R @@ -23,17 +23,15 @@ #' @return A tibble of monthly flows. #' #' @format A tibble with 8 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Year}{Year of record.} -#' \item{Month}{Numeric month value} -#' \item{Full_Month}{Logical value is there is full record from Month} -#' \item{No_days}{Number of days in that month} -#' \item{Sum_stat}{Summary statistic being used.} -#' \item{Value}{Value of the measurement in m^3/s.} -#' \item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -#' and therefore has an NA value for Date.} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Year**: Year of record. +#' - **Month**: Numeric month value +#' - **Full_Month**: Logical value is there is full record from Month +#' - **No_days**: Number of days in that month +#' - **Sum_stat**: Summary statistic being used. +#' - **Value**: Value of the measurement in m^3/s. +#' - **Date_occurred**: Observation date. Formatted as a Date class. MEAN is a annual summary +#' and therefore has an NA value for Date. #' #' @examples #' \dontrun{ diff --git a/R/hy_monthly_levels.R b/R/hy_monthly_levels.R index 9f3c11f..686ff0b 100644 --- a/R/hy_monthly_levels.R +++ b/R/hy_monthly_levels.R @@ -23,17 +23,15 @@ #' @return A tibble of monthly levels. #' #' @format A tibble with 8 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Year}{Year of record.} -#' \item{Month}{Numeric month value} -#' \item{Full_month}{Logical value is there is full record from Month} -#' \item{No_days}{Number of days in that month} -#' \item{Sum_stat}{Summary statistic being used.} -#' \item{Value}{Value of the measurement in metres.} -#' \item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -#' and therefore has an NA value for Date.} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Year**: Year of record. +#' - **Month**: Numeric month value +#' - **Full_month**: Logical value is there is full record from Month +#' - **No_days**: Number of days in that month +#' - **Sum_stat**: Summary statistic being used. +#' - **Value**: Value of the measurement in metres. +#' - **Date_occurred**: Observation date. Formatted as a Date class. MEAN is a annual summary +#' and therefore has an NA value for Date. #' #' @examples #' \dontrun{ diff --git a/R/hy_plot.R b/R/hy_plot.R index 6ae951f..e5e66fc 100644 --- a/R/hy_plot.R +++ b/R/hy_plot.R @@ -160,7 +160,7 @@ label_helper <- function(parameter) { #' This function is deprecated in favour of generic plot methods #' #' This is an easy way to visualize a single station using base R graphics. -#' More complicated plotting needs should consider using \code{ggplot2}. Inputting more +#' More complicated plotting needs should consider using `ggplot2`. Inputting more #' 5 stations will result in very busy plots and longer load time. Legend position will #' sometimes overlap plotted points. #' diff --git a/R/hy_sed_daily_loads.R b/R/hy_sed_daily_loads.R index 0ae6835..037195d 100644 --- a/R/hy_sed_daily_loads.R +++ b/R/hy_sed_daily_loads.R @@ -13,8 +13,8 @@ #' Extract daily sediment load information from the HYDAT database #' #' Provides wrapper to turn the SED_DLY_LOADS table in HYDAT into a tidy data frame of daily sediment load information. -#' \code{station_number} and \code{prov_terr_state_loc} can both be supplied. If both are omitted all values from the -#' \code{hy_stations} table are returned. That is a large vector for \code{hy_sed_daily_loads}. +#' `station_number` and `prov_terr_state_loc` can both be supplied. If both are omitted all values from the +#' `hy_stations` table are returned. That is a large vector for `hy_sed_daily_loads`. #' #' @inheritParams hy_stations #' @param start_date Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive. @@ -23,12 +23,10 @@ #' @return A tibble of daily suspended sediment loads #' #' @format A tibble with 4 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date. Formatted as a Date class.} -#' \item{Parameter}{Parameter being measured. Only possible value is Load} -#' \item{Value}{Discharge value. The units are tonnes.} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date. Formatted as a Date class. +#' - **Parameter**: Parameter being measured. Only possible value is Load +#' - **Value**: Discharge value. The units are tonnes. #' #' @examples #' \dontrun{ diff --git a/R/hy_sed_daily_suscon.R b/R/hy_sed_daily_suscon.R index 9c110fc..c5913d3 100644 --- a/R/hy_sed_daily_suscon.R +++ b/R/hy_sed_daily_suscon.R @@ -13,21 +13,19 @@ #' Extract daily suspended sediment concentration information from the HYDAT database #' #' Provides wrapper to turn the SED_DLY_SUSCON table in HYDAT into a tidy data frame of daily suspended sediment concentration information. -#' \code{station_number} and \code{prov_terr_state_loc} can both be supplied. If both are omitted all values from the \code{hy_stations} -#' table are returned. That is a large vector for \code{hy_sed_daily_suscon}. +#' `station_number` and `prov_terr_state_loc` can both be supplied. If both are omitted all values from the `hy_stations` +#' table are returned. That is a large vector for `hy_sed_daily_suscon`. #' #' @inheritParams hy_daily_flows #' #' @return A tibble of daily suspended sediment concentration #' #' @format A tibble with 5 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date. Formatted as a Date class.} -#' \item{Parameter}{Parameter being measured. Only possible value is Suscon} -#' \item{Value}{Discharge value. The units are mg/l.} -#' \item{Symbol}{Measurement/river conditions} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date. Formatted as a Date class. +#' - **Parameter**: Parameter being measured. Only possible value is Suscon +#' - **Value**: Discharge value. The units are mg/l. +#' - **Symbol**: Measurement/river conditions #' #' @examples #' \dontrun{ diff --git a/R/hy_sed_monthly_loads.R b/R/hy_sed_monthly_loads.R index e7a87ee..273e8e7 100644 --- a/R/hy_sed_monthly_loads.R +++ b/R/hy_sed_monthly_loads.R @@ -23,17 +23,15 @@ #' @return A tibble of monthly sediment loads. #' #' @format A tibble with 8 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Year}{Year of record.} -#' \item{Month}{Numeric month value} -#' \item{Full_Month}{Logical value is there is full record from Month} -#' \item{No_days}{Number of days in that month} -#' \item{Sum_stat}{Summary statistic being used.} -#' \item{Value}{Value of the measurement in tonnes.} -#' \item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -#' and therefore has an NA value for Date.} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Year**: Year of record. +#' - **Month**: Numeric month value +#' - **Full_Month**: Logical value is there is full record from Month +#' - **No_days**: Number of days in that month +#' - **Sum_stat**: Summary statistic being used. +#' - **Value**: Value of the measurement in tonnes. +#' - **Date_occurred**: Observation date. Formatted as a Date class. MEAN is a annual summary +#' and therefore has an NA value for Date. #' #' @examples #' \dontrun{ diff --git a/R/hy_sed_monthly_suscon.R b/R/hy_sed_monthly_suscon.R index b00676e..a14f527 100644 --- a/R/hy_sed_monthly_suscon.R +++ b/R/hy_sed_monthly_suscon.R @@ -23,17 +23,15 @@ #' @return A tibble of monthly suspended sediment concentrations. #' #' @format A tibble with 8 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Year}{Year of record.} -#' \item{Month}{Numeric month value} -#' \item{Full_Month}{Logical value is there is full record from Month} -#' \item{No_days}{Number of days in that month} -#' \item{Sum_stat}{Summary statistic being used.} -#' \item{Value}{Value of the measurement in mg/l.} -#' \item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -#' and therefore has an NA value for Date.} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Year**: Year of record. +#' - **Month**: Numeric month value +#' - **Full_Month**: Logical value is there is full record from Month +#' - **No_days**: Number of days in that month +#' - **Sum_stat**: Summary statistic being used. +#' - **Value**: Value of the measurement in mg/l. +#' - **Date_occurred**: Observation date. Formatted as a Date class. MEAN is a annual summary +#' and therefore has an NA value for Date. #' #' @examples #' \dontrun{ diff --git a/R/hy_sed_samples.R b/R/hy_sed_samples.R index 289029b..0cba995 100644 --- a/R/hy_sed_samples.R +++ b/R/hy_sed_samples.R @@ -23,25 +23,23 @@ #' @return A tibble of instantaneous sediment samples data #' #' @format A tibble with 19 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{SED_DATA_TYPE}{Contains the type of sampling method used in collecting sediment for a station} -#' \item{Date}{Contains the time to the nearest minute of when the sample was taken} -#' \item{SAMPLE_REMARK_CODE}{Descriptive Sediment Sample Remark in English} -#' \item{TIME_SYMBOL}{An "E" symbol means the time is an estimate only} -#' \item{FLOW}{Contains the instantaneous discharge in cubic metres per second at the time the sample was taken} -#' \item{SYMBOL_EN}{Indicates a condition where the daily mean has a larger than expected error} -#' \item{SAMPLER_TYPE}{Contains the type of measurement device used to take the sample} -#' \item{SAMPLING_VERTICAL_LOCATION}{The location on the cross-section of the river -#' at which the single sediment samples are collected. If one of the standard -#' locations is not used the distance in meters will be shown} -#' \item{SAMPLING_VERTICAL_EN}{Indicates sample location relative to the -#' regular measurement cross-section or the regular sampling site} -#' \item{TEMPERATURE}{Contains the instantaneous water temperature -#' in Celsius at the time the sample was taken} -#' \item{CONCENTRATION_EN}{Contains the instantaneous concentration sampled in milligrams per litre} -#' \item{SV_DEPTH2}{Depth 2 for split vertical depth integrating (m)} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **SED_DATA_TYPE**: Contains the type of sampling method used in collecting sediment for a station +#' - **Date**: Contains the time to the nearest minute of when the sample was taken +#' - **SAMPLE_REMARK_CODE**: Descriptive Sediment Sample Remark in English +#' - **TIME_SYMBOL**: An "E" symbol means the time is an estimate only +#' - **FLOW**: Contains the instantaneous discharge in cubic metres per second at the time the sample was taken +#' - **SYMBOL_EN**: Indicates a condition where the daily mean has a larger than expected error +#' - **SAMPLER_TYPE**: Contains the type of measurement device used to take the sample +#' - **SAMPLING_VERTICAL_LOCATION**: The location on the cross-section of the river +#' at which the single sediment samples are collected. If one of the standard +#' locations is not used the distance in meters will be shown +#' - **SAMPLING_VERTICAL_EN**: Indicates sample location relative to the +#' regular measurement cross-section or the regular sampling site +#' - **TEMPERATURE**: Contains the instantaneous water temperature +#' in Celsius at the time the sample was taken +#' - **CONCENTRATION_EN**: Contains the instantaneous concentration sampled in milligrams per litre +#' - **SV_DEPTH2**: Depth 2 for split vertical depth integrating (m) #' #' @examples #' \dontrun{ diff --git a/R/hy_sed_samples_psd.R b/R/hy_sed_samples_psd.R index 9555b7b..b85b24a 100644 --- a/R/hy_sed_samples_psd.R +++ b/R/hy_sed_samples_psd.R @@ -23,13 +23,11 @@ #' @return A tibble of sediment sample particle size data #' #' @format A tibble with 5 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{SED_DATA_TYPE}{Contains the type of sampling method used in collecting sediment for a station} -#' \item{Date}{Contains the time to the nearest minute of when the sample was taken} -#' \item{PARTICLE_SIZE}{Particle size (mm)} -#' \item{PERCENT}{Contains the percentage values for indicated particle sizes for samples collected} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **SED_DATA_TYPE**: Contains the type of sampling method used in collecting sediment for a station +#' - **Date**: Contains the time to the nearest minute of when the sample was taken +#' - **PARTICLE_SIZE**: Particle size (mm) +#' - **PERCENT**: Contains the percentage values for indicated particle sizes for samples collected #' #' #' @examples diff --git a/R/hy_stations.R b/R/hy_stations.R index 7d69d7a..98c56a3 100644 --- a/R/hy_stations.R +++ b/R/hy_stations.R @@ -26,30 +26,28 @@ #' @return A tibble of stations and associated metadata #' #' @format A tibble with 15 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{STATION_NAME}{Official name for station identification} -#' \item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -#' \item{REGIONAL_OFFICE_ID}{The identifier of the regional office responsible for the station. -#' Links to \link[tidyhydat]{hy_reg_office_list}} -#' \item{HYD_STATUS}{Current status of discharge or level monitoring in the hydrometric network} -#' \item{SED_STATUS}{Current status of sediment monitoring in the hydrometric network} -#' \item{LATITUDE}{North-South Coordinates of the gauging station in decimal degrees} -#' \item{LONGITUDE}{East-West Coordinates of the gauging station in decimal degrees} -#' \item{DRAINAGE_AREA_GROSS}{The total surface area that drains to the gauge site (km^2)} -#' \item{DRAINAGE_AREA_EFFECT}{The portion of the drainage basin that contributes runoff to +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **STATION_NAME**: Official name for station identification +#' - **PROV_TERR_STATE_LOC**: The province, territory or state in which the station is located +#' - **REGIONAL_OFFICE_ID**: The identifier of the regional office responsible for the station. +#' Links to [hy_reg_office_list][tidyhydat::hy_reg_office_list] +#' - **HYD_STATUS**: Current status of discharge or level monitoring in the hydrometric network +#' - **SED_STATUS**: Current status of sediment monitoring in the hydrometric network +#' - **LATITUDE**: North-South Coordinates of the gauging station in decimal degrees +#' - **LONGITUDE**: East-West Coordinates of the gauging station in decimal degrees +#' - **DRAINAGE_AREA_GROSS**: The total surface area that drains to the gauge site (km^2) +#' - **DRAINAGE_AREA_EFFECT**: The portion of the drainage basin that contributes runoff to #' the gauge site, calculated by subtracting any noncontributing portion from the -#' gross drainage area (km^2)} -#' \item{RHBN}{Logical. Reference Hydrometric Basin Network station. The Reference Hydrometric +#' gross drainage area (km^2) +#' - **RHBN**: Logical. Reference Hydrometric Basin Network station. The Reference Hydrometric #' Basin Network (RHBN) is a sub-set of the national network that has been identified -#' for use in the detection, monitoring, and assessment of climate change.} -#' \item{REAL_TIME}{Logical. Indicates if a station has the capacity to deliver data in -#' real-time or near real-time} -#' \item{CONTRIBUTOR_ID}{Unique ID of an agency that contributes data to the -#' HYDAT database. The agency is non-WSC and non WSC funded} -#' \item{OPERATOR_ID}{Unique ID of an agency that operates a hydrometric station} -#' \item{DATUM_ID}{Unique ID for a datum} -#' } +#' for use in the detection, monitoring, and assessment of climate change. +#' - **REAL_TIME**: Logical. Indicates if a station has the capacity to deliver data in +#' real-time or near real-time +#' - **CONTRIBUTOR_ID**: Unique ID of an agency that contributes data to the +#' HYDAT database. The agency is non-WSC and non WSC funded +#' - **OPERATOR_ID**: Unique ID of an agency that operates a hydrometric station +#' - **DATUM_ID**: Unique ID for a datum #' #' @examples #' \dontrun{ diff --git a/R/realtime-webservice.R b/R/realtime-webservice.R index 4bb7a01..3d81f76 100755 --- a/R/realtime-webservice.R +++ b/R/realtime-webservice.R @@ -19,7 +19,7 @@ #' parameters or dates) being requested. #' #' @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} +#' @param parameters parameter ID. Can take multiple entries. Parameter is a numeric code. See `param_id` #' for some options though undocumented parameters may be implemented. Defaults to Water level provisional, Secondary water level, #' Tertiary water level, Discharge Provisional, Discharge, sensor, Water temperature, Secondary water temperature, Accumulated precipitation #' @param start_date Accepts either YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. @@ -31,18 +31,16 @@ #' #' #' @format A tibble with 6 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{Date}{Observation date and time. Formatted as a POSIXct class as UTC for consistency.} -#' \item{Name_En}{Code name in English} -#' \item{Value}{Value of the measurement.} -#' \item{Unit}{Value units} -#' \item{Grade}{future use} -#' \item{Symbol}{future use} -#' \item{Approval}{future use} -#' \item{Parameter}{Numeric parameter code} -#' \item{Code}{Letter parameter code} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **Date**: Observation date and time. Formatted as a POSIXct class as UTC for consistency. +#' - **Name_En**: Code name in English +#' - **Value**: Value of the measurement. +#' - **Unit**: Value units +#' - **Grade**: future use +#' - **Symbol**: future use +#' - **Approval**: future use +#' - **Parameter**: Numeric parameter code +#' - **Code**: Letter parameter code #' #' @examples #' \dontrun{ diff --git a/R/realtime.R b/R/realtime.R index 8e1aec4..fefd387 100644 --- a/R/realtime.R +++ b/R/realtime.R @@ -23,18 +23,16 @@ #' stored as an attribute. #' #' @format A tibble with 8 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -#' \item{Date}{Observation date and time for last thirty days. Formatted as a POSIXct class in UTC for consistency.} -#' \item{Parameter}{Parameter being measured. Only possible values are Flow and Level} -#' \item{Value}{Value of the measurement. If Parameter equals Flow the units are m^3/s. -#' If Parameter equals Level the units are metres.} -#' \item{Grade}{reserved for future use} -#' \item{Symbol}{reserved for future use} -#' \item{Code}{quality assurance/quality control flag for the discharge} -#' \item{station_tz}{Station timezone based on tidyhydat::allstations$station_tz} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **PROV_TERR_STATE_LOC**: The province, territory or state in which the station is located +#' - **Date**: Observation date and time for last thirty days. Formatted as a POSIXct class in UTC for consistency. +#' - **Parameter**: Parameter being measured. Only possible values are Flow and Level +#' - **Value**: Value of the measurement. If Parameter equals Flow the units are m^3/s. +#' If Parameter equals Level the units are metres. +#' - **Grade**: reserved for future use +#' - **Symbol**: reserved for future use +#' - **Code**: quality assurance/quality control flag for the discharge +#' - **station_tz**: Station timezone based on tidyhydat::allstations$station_tz #' #' @examples #' \dontrun{ @@ -76,14 +74,12 @@ realtime_dd <- function(station_number = NULL, prov_terr_state_loc = NULL) { #' @family realtime functions #' #' @format A tibble with 6 variables: -#' \describe{ -#' \item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -#' \item{STATION_NAME}{Official name for station identification} -#' \item{LATITUDE}{North-South Coordinates of the gauging station in decimal degrees} -#' \item{LONGITUDE}{East-West Coordinates of the gauging station in decimal degrees} -#' \item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -#' \item{TIMEZONE}{Timezone of the station} -#' } +#' - **STATION_NUMBER**: Unique 7 digit Water Survey of Canada station number +#' - **STATION_NAME**: Official name for station identification +#' - **LATITUDE**: North-South Coordinates of the gauging station in decimal degrees +#' - **LONGITUDE**: East-West Coordinates of the gauging station in decimal degrees +#' - **PROV_TERR_STATE_LOC**: The province, territory or state in which the station is located +#' - **TIMEZONE**: Timezone of the station #' #' @export #' @@ -153,8 +149,8 @@ realtime_stations <- function(prov_terr_state_loc = NULL) { #' Adds `local_datetime` and `tz_used` columns based on either the most common timezone in the original data or #' a user supplied timezone. This function is meant to used in a pipe with the `realtime_dd()` function. #' -#' @param .data Tibble created by \code{realtime_dd} -#' @param set_tz A timezone string in the format of \code{OlsonNames()} +#' @param .data Tibble created by `realtime_dd` +#' @param set_tz A timezone string in the format of `OlsonNames()` #' #' @details `Date` from `realtime_dd` is supplied in UTC which is the easiest format to work with across timezones. This function #' does not change `Date` from UTC. Rather `station_tz` specifies the local timezone name and is useful in instances where diff --git a/R/realtime_plot.R b/R/realtime_plot.R index 2e334cb..81e3994 100644 --- a/R/realtime_plot.R +++ b/R/realtime_plot.R @@ -130,7 +130,7 @@ plot.realtime <- function(x = NULL, Parameter = c("Flow", "Level"), ...) { #' Convenience function to plot realtime data #' #' This is an easy way to visualize a single station using base R graphics. -#' More complicated plotting needs should consider using \code{ggplot2}. Inputting more +#' More complicated plotting needs should consider using `ggplot2`. Inputting more #' 5 stations will result in very busy plots and longer load time. Legend position will #' sometimes overlap plotted points. #' diff --git a/R/utils.R b/R/utils.R index 4d15c1b..9df4574 100644 --- a/R/utils.R +++ b/R/utils.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 Function to chose a station based on consistent arguments for hydat functions. +#' Function to chose a station based on consistent arguments for hydat functions. #' -#' @description A function to avoid duplication in HYDAT functions. This function is not intended for external use. +#' A function to avoid duplication in HYDAT functions. This function is not intended for external use. #' #' @inheritParams hy_stations #' @param hydat_con A database connection @@ -245,9 +245,9 @@ tidyhydat_agent <- function(req) { #' Convenience function to pull station number from tidyhydat functions #' -#' This function mimics \code{dplyr::pull} to avoid having to always type +#' This function mimics `dplyr::pull` to avoid having to always type #' dplyr::pull(STATION_NUMBER). Instead we can now take advantage of autocomplete. -#' This can be used with \code{realtime_} and \code{hy_} functions. +#' This can be used with `realtime_` and `hy_` functions. #' #' @param .data A table of data #' @@ -392,4 +392,4 @@ construct_url <- function( parameters_string, "&", date_string ) -} \ No newline at end of file +} diff --git a/man/allstations.Rd b/man/allstations.Rd index 68269dc..6316224 100644 --- a/man/allstations.Rd +++ b/man/allstations.Rd @@ -6,17 +6,17 @@ \title{All Canadian stations} \format{ A tibble with 5 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{STATION_NAME}{Official name for station identification} -\item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -\item{HYD_STATUS}{Current status of discharge or level monitoring in the hydrometric network} -\item{REAL_TIME}{Logical. Indicates if a station has the capacity to deliver data in -real-time or near real-time} -\item{LATITUDE}{North-South Coordinates of the gauging station in decimal degrees} -\item{LONGITUDE}{East-West Coordinates of the gauging station in decimal degrees} -\item{station_tz}{Timezone of station calculated using the lutz package based on LAT/LONG of stations} -\item{standard_offset}{Offset from UTC of local standard time} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{STATION_NAME}: Official name for station identification +\item \strong{PROV_TERR_STATE_LOC}: The province, territory or state in which the station is located +\item \strong{HYD_STATUS}: Current status of discharge or level monitoring in the hydrometric network +\item \strong{REAL_TIME}: Logical. Indicates if a station has the capacity to deliver data in +real-time or near real-time +\item \strong{LATITUDE}: North-South Coordinates of the gauging station in decimal degrees +\item \strong{LONGITUDE}: East-West Coordinates of the gauging station in decimal degrees +\item \strong{station_tz}: Timezone of station calculated using the lutz package based on LAT/LONG of stations +\item \strong{standard_offset}: Offset from UTC of local standard time } } \source{ diff --git a/man/available_flows.Rd b/man/available_flows.Rd index f67534c..4b20f3e 100644 --- a/man/available_flows.Rd +++ b/man/available_flows.Rd @@ -5,13 +5,13 @@ \title{Get all available flow data (final + provisional)} \format{ A tibble with 6 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date. Formatted as a Date class.} -\item{Parameter}{Parameter being measured. Value is "Flow"} -\item{Value}{Discharge value. The units are m^3/s.} -\item{Symbol}{Measurement/river conditions} -\item{Approval}{Approval status: "final" (approved) or "provisional" (subject to revision)} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date. Formatted as a Date class. +\item \strong{Parameter}: Parameter being measured. Value is "Flow" +\item \strong{Value}: Discharge value. The units are m^3/s. +\item \strong{Symbol}: Measurement/river conditions +\item \strong{Approval}: Approval status: "final" (approved) or "provisional" (subject to revision) } } \usage{ @@ -35,7 +35,7 @@ Defaults to current date (Sys.Date()).} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/available_levels.Rd b/man/available_levels.Rd index 81ee4c5..d537acd 100644 --- a/man/available_levels.Rd +++ b/man/available_levels.Rd @@ -5,13 +5,13 @@ \title{Get all available level data (final + provisional)} \format{ A tibble with 6 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date. Formatted as a Date class.} -\item{Parameter}{Parameter being measured. Value is "Level"} -\item{Value}{Level value. The units are metres.} -\item{Symbol}{Measurement/river conditions} -\item{Approval}{Approval status: "final" (approved) or "provisional" (subject to revision)} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date. Formatted as a Date class. +\item \strong{Parameter}: Parameter being measured. Value is "Level" +\item \strong{Value}: Level value. The units are metres. +\item \strong{Symbol}: Measurement/river conditions +\item \strong{Approval}: Approval status: "final" (approved) or "provisional" (subject to revision) } } \usage{ @@ -35,7 +35,7 @@ Defaults to current date (Sys.Date()).} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_agency_list.Rd b/man/hy_agency_list.Rd index 6082fde..33f637b 100644 --- a/man/hy_agency_list.Rd +++ b/man/hy_agency_list.Rd @@ -12,7 +12,7 @@ hy_agency_list(hydat_path = NULL) \arguments{ \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} } \value{ diff --git a/man/hy_annual_instant_peaks.Rd b/man/hy_annual_instant_peaks.Rd index ae141e1..5bdc634 100644 --- a/man/hy_annual_instant_peaks.Rd +++ b/man/hy_annual_instant_peaks.Rd @@ -21,7 +21,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_annual_stats.Rd b/man/hy_annual_stats.Rd index fbe9643..a0cc3cb 100644 --- a/man/hy_annual_stats.Rd +++ b/man/hy_annual_stats.Rd @@ -5,16 +5,16 @@ \title{Extract annual statistics information from the HYDAT database} \format{ A tibble with 8 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Parameter}{Parameter being measured. Only possible values are FLOW and LEVEL} -\item{Year}{Year of record.} -\item{Sum_stat}{Summary statistic being used.} -\item{Value}{Value of the measurement. If Parameter equals FLOW the units are m^3/s. If Parameter equals LEVEL the -units are metres.} -\item{Date}{Observation date. Formatted as a Date class. MEAN is a annual summary -and therefore has an NA value for Date.} -\item{Symbol}{Measurement/river conditions} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Parameter}: Parameter being measured. Only possible values are FLOW and LEVEL +\item \strong{Year}: Year of record. +\item \strong{Sum_stat}: Summary statistic being used. +\item \strong{Value}: Value of the measurement. If Parameter equals FLOW the units are m^3/s. If Parameter equals LEVEL the +units are metres. +\item \strong{Date}: Observation date. Formatted as a Date class. MEAN is a annual summary +and therefore has an NA value for Date. +\item \strong{Symbol}: Measurement/river conditions } } \source{ @@ -35,7 +35,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_daily.Rd b/man/hy_daily.Rd index e5678f1..9db0834 100644 --- a/man/hy_daily.Rd +++ b/man/hy_daily.Rd @@ -5,12 +5,12 @@ \title{Extract all daily water level and flow measurements} \format{ A tibble with 5 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date. Formatted as a Date class.} -\item{Parameter}{Parameter being measured.} -\item{Value}{Discharge value. The units are m^3/s.} -\item{Symbol}{Measurement/river conditions} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date. Formatted as a Date class. +\item \strong{Parameter}: Parameter being measured. +\item \strong{Value}: Discharge value. The units are m^3/s. +\item \strong{Symbol}: Measurement/river conditions } } \source{ @@ -33,7 +33,7 @@ is returned. See \code{unique(allstations$prov_terr_state_loc)}. Will also accep \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{...}{See \code{\link[=hy_daily_flows]{hy_daily_flows()}} arguments} diff --git a/man/hy_daily_flows.Rd b/man/hy_daily_flows.Rd index 73cf397..901c8b2 100644 --- a/man/hy_daily_flows.Rd +++ b/man/hy_daily_flows.Rd @@ -5,12 +5,12 @@ \title{Extract daily flows information from HYDAT database or web service} \format{ A tibble with 5 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date. Formatted as a Date class.} -\item{Parameter}{Parameter being measured. Only possible value is Flow} -\item{Value}{Discharge value. The units are m^3/s.} -\item{Symbol}{Measurement/river conditions} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date. Formatted as a Date class. +\item \strong{Parameter}: Parameter being measured. Only possible value is Flow +\item \strong{Value}: Discharge value. The units are m^3/s. +\item \strong{Symbol}: Measurement/river conditions } } \source{ @@ -32,7 +32,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_daily_levels.Rd b/man/hy_daily_levels.Rd index 1523ed1..4795baf 100644 --- a/man/hy_daily_levels.Rd +++ b/man/hy_daily_levels.Rd @@ -5,12 +5,12 @@ \title{Extract daily levels information from HYDAT database or web service} \format{ A tibble with 5 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date. Formatted as a Date class.} -\item{Parameter}{Parameter being measured. Only possible value is Level} -\item{Value}{Level value. The units are metres.} -\item{Symbol}{Measurement/river conditions} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date. Formatted as a Date class. +\item \strong{Parameter}: Parameter being measured. Only possible value is Level +\item \strong{Value}: Level value. The units are metres. +\item \strong{Symbol}: Measurement/river conditions } } \source{ @@ -32,7 +32,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_data_symbols.Rd b/man/hy_data_symbols.Rd index d5fa3ac..a47c43c 100644 --- a/man/hy_data_symbols.Rd +++ b/man/hy_data_symbols.Rd @@ -6,10 +6,10 @@ \title{DATA SYMBOLS look-up table} \format{ A tibble with 5 rows and 3 variables: -\describe{ -\item{SYMBOL_ID}{Symbol code} -\item{SYMBOL_EN}{Description of Symbol (English)} -\item{SYMBOL_FR}{Description of Symbol (French)} +\itemize{ +\item \strong{SYMBOL_ID}: Symbol code +\item \strong{SYMBOL_EN}: Description of Symbol (English) +\item \strong{SYMBOL_FR}: Description of Symbol (French) } } \source{ diff --git a/man/hy_data_types.Rd b/man/hy_data_types.Rd index 0292d4c..9b0e9ad 100644 --- a/man/hy_data_types.Rd +++ b/man/hy_data_types.Rd @@ -6,10 +6,10 @@ \title{DATA TYPES look-up table} \format{ A tibble with 5 rows and 3 variables: -\describe{ -\item{DATA_TYPE}{Data type code} -\item{DATA_TYPE_EN}{Descriptive data type (English)} -\item{DATA_TYPE_FR}{Descriptive data type (French)} +\itemize{ +\item \strong{DATA_TYPE}: Data type code +\item \strong{DATA_TYPE_EN}: Descriptive data type (English) +\item \strong{DATA_TYPE_FR}: Descriptive data type (French) } } \source{ diff --git a/man/hy_datum_list.Rd b/man/hy_datum_list.Rd index 0662d5d..e3f668c 100644 --- a/man/hy_datum_list.Rd +++ b/man/hy_datum_list.Rd @@ -12,7 +12,7 @@ hy_datum_list(hydat_path = NULL) \arguments{ \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} } \value{ diff --git a/man/hy_monthly_flows.Rd b/man/hy_monthly_flows.Rd index 305df66..d365dbd 100644 --- a/man/hy_monthly_flows.Rd +++ b/man/hy_monthly_flows.Rd @@ -5,16 +5,16 @@ \title{Extract monthly flows information from the HYDAT database} \format{ A tibble with 8 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Year}{Year of record.} -\item{Month}{Numeric month value} -\item{Full_Month}{Logical value is there is full record from Month} -\item{No_days}{Number of days in that month} -\item{Sum_stat}{Summary statistic being used.} -\item{Value}{Value of the measurement in m^3/s.} -\item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -and therefore has an NA value for Date.} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Year}: Year of record. +\item \strong{Month}: Numeric month value +\item \strong{Full_Month}: Logical value is there is full record from Month +\item \strong{No_days}: Number of days in that month +\item \strong{Sum_stat}: Summary statistic being used. +\item \strong{Value}: Value of the measurement in m^3/s. +\item \strong{Date_occurred}: Observation date. Formatted as a Date class. MEAN is a annual summary +and therefore has an NA value for Date. } } \source{ @@ -35,7 +35,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_monthly_levels.Rd b/man/hy_monthly_levels.Rd index 4897152..85846d8 100644 --- a/man/hy_monthly_levels.Rd +++ b/man/hy_monthly_levels.Rd @@ -5,16 +5,16 @@ \title{Extract monthly levels information from the HYDAT database} \format{ A tibble with 8 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Year}{Year of record.} -\item{Month}{Numeric month value} -\item{Full_month}{Logical value is there is full record from Month} -\item{No_days}{Number of days in that month} -\item{Sum_stat}{Summary statistic being used.} -\item{Value}{Value of the measurement in metres.} -\item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -and therefore has an NA value for Date.} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Year}: Year of record. +\item \strong{Month}: Numeric month value +\item \strong{Full_month}: Logical value is there is full record from Month +\item \strong{No_days}: Number of days in that month +\item \strong{Sum_stat}: Summary statistic being used. +\item \strong{Value}: Value of the measurement in metres. +\item \strong{Date_occurred}: Observation date. Formatted as a Date class. MEAN is a annual summary +and therefore has an NA value for Date. } } \source{ @@ -35,7 +35,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_reg_office_list.Rd b/man/hy_reg_office_list.Rd index 4f55bed..32a4685 100644 --- a/man/hy_reg_office_list.Rd +++ b/man/hy_reg_office_list.Rd @@ -12,7 +12,7 @@ hy_reg_office_list(hydat_path = NULL) \arguments{ \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} } \value{ diff --git a/man/hy_sed_daily_loads.Rd b/man/hy_sed_daily_loads.Rd index fd92cd7..e85281d 100644 --- a/man/hy_sed_daily_loads.Rd +++ b/man/hy_sed_daily_loads.Rd @@ -5,11 +5,11 @@ \title{Extract daily sediment load information from the HYDAT database} \format{ A tibble with 4 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date. Formatted as a Date class.} -\item{Parameter}{Parameter being measured. Only possible value is Load} -\item{Value}{Discharge value. The units are tonnes.} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date. Formatted as a Date class. +\item \strong{Parameter}: Parameter being measured. Only possible value is Load +\item \strong{Value}: Discharge value. The units are tonnes. } } \source{ @@ -30,7 +30,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_sed_daily_suscon.Rd b/man/hy_sed_daily_suscon.Rd index 2fefedf..a985637 100644 --- a/man/hy_sed_daily_suscon.Rd +++ b/man/hy_sed_daily_suscon.Rd @@ -5,12 +5,12 @@ \title{Extract daily suspended sediment concentration information from the HYDAT database} \format{ A tibble with 5 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date. Formatted as a Date class.} -\item{Parameter}{Parameter being measured. Only possible value is Suscon} -\item{Value}{Discharge value. The units are mg/l.} -\item{Symbol}{Measurement/river conditions} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date. Formatted as a Date class. +\item \strong{Parameter}: Parameter being measured. Only possible value is Suscon +\item \strong{Value}: Discharge value. The units are mg/l. +\item \strong{Symbol}: Measurement/river conditions } } \source{ @@ -32,7 +32,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_sed_monthly_loads.Rd b/man/hy_sed_monthly_loads.Rd index 4f1c1e4..ab2f3de 100644 --- a/man/hy_sed_monthly_loads.Rd +++ b/man/hy_sed_monthly_loads.Rd @@ -5,16 +5,16 @@ \title{Extract monthly flows information from the HYDAT database} \format{ A tibble with 8 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Year}{Year of record.} -\item{Month}{Numeric month value} -\item{Full_Month}{Logical value is there is full record from Month} -\item{No_days}{Number of days in that month} -\item{Sum_stat}{Summary statistic being used.} -\item{Value}{Value of the measurement in tonnes.} -\item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -and therefore has an NA value for Date.} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Year}: Year of record. +\item \strong{Month}: Numeric month value +\item \strong{Full_Month}: Logical value is there is full record from Month +\item \strong{No_days}: Number of days in that month +\item \strong{Sum_stat}: Summary statistic being used. +\item \strong{Value}: Value of the measurement in tonnes. +\item \strong{Date_occurred}: Observation date. Formatted as a Date class. MEAN is a annual summary +and therefore has an NA value for Date. } } \source{ @@ -35,7 +35,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_sed_monthly_suscon.Rd b/man/hy_sed_monthly_suscon.Rd index b9cc20e..54719e3 100644 --- a/man/hy_sed_monthly_suscon.Rd +++ b/man/hy_sed_monthly_suscon.Rd @@ -5,16 +5,16 @@ \title{Extract monthly flows information from the HYDAT database} \format{ A tibble with 8 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Year}{Year of record.} -\item{Month}{Numeric month value} -\item{Full_Month}{Logical value is there is full record from Month} -\item{No_days}{Number of days in that month} -\item{Sum_stat}{Summary statistic being used.} -\item{Value}{Value of the measurement in mg/l.} -\item{Date_occurred}{Observation date. Formatted as a Date class. MEAN is a annual summary -and therefore has an NA value for Date.} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Year}: Year of record. +\item \strong{Month}: Numeric month value +\item \strong{Full_Month}: Logical value is there is full record from Month +\item \strong{No_days}: Number of days in that month +\item \strong{Sum_stat}: Summary statistic being used. +\item \strong{Value}: Value of the measurement in mg/l. +\item \strong{Date_occurred}: Observation date. Formatted as a Date class. MEAN is a annual summary +and therefore has an NA value for Date. } } \source{ @@ -35,7 +35,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_sed_samples.Rd b/man/hy_sed_samples.Rd index fc992af..0826954 100644 --- a/man/hy_sed_samples.Rd +++ b/man/hy_sed_samples.Rd @@ -5,24 +5,24 @@ \title{Extract instantaneous sediment sample information from the HYDAT database} \format{ A tibble with 19 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{SED_DATA_TYPE}{Contains the type of sampling method used in collecting sediment for a station} -\item{Date}{Contains the time to the nearest minute of when the sample was taken} -\item{SAMPLE_REMARK_CODE}{Descriptive Sediment Sample Remark in English} -\item{TIME_SYMBOL}{An "E" symbol means the time is an estimate only} -\item{FLOW}{Contains the instantaneous discharge in cubic metres per second at the time the sample was taken} -\item{SYMBOL_EN}{Indicates a condition where the daily mean has a larger than expected error} -\item{SAMPLER_TYPE}{Contains the type of measurement device used to take the sample} -\item{SAMPLING_VERTICAL_LOCATION}{The location on the cross-section of the river +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{SED_DATA_TYPE}: Contains the type of sampling method used in collecting sediment for a station +\item \strong{Date}: Contains the time to the nearest minute of when the sample was taken +\item \strong{SAMPLE_REMARK_CODE}: Descriptive Sediment Sample Remark in English +\item \strong{TIME_SYMBOL}: An "E" symbol means the time is an estimate only +\item \strong{FLOW}: Contains the instantaneous discharge in cubic metres per second at the time the sample was taken +\item \strong{SYMBOL_EN}: Indicates a condition where the daily mean has a larger than expected error +\item \strong{SAMPLER_TYPE}: Contains the type of measurement device used to take the sample +\item \strong{SAMPLING_VERTICAL_LOCATION}: The location on the cross-section of the river at which the single sediment samples are collected. If one of the standard -locations is not used the distance in meters will be shown} -\item{SAMPLING_VERTICAL_EN}{Indicates sample location relative to the -regular measurement cross-section or the regular sampling site} -\item{TEMPERATURE}{Contains the instantaneous water temperature -in Celsius at the time the sample was taken} -\item{CONCENTRATION_EN}{Contains the instantaneous concentration sampled in milligrams per litre} -\item{SV_DEPTH2}{Depth 2 for split vertical depth integrating (m)} +locations is not used the distance in meters will be shown +\item \strong{SAMPLING_VERTICAL_EN}: Indicates sample location relative to the +regular measurement cross-section or the regular sampling site +\item \strong{TEMPERATURE}: Contains the instantaneous water temperature +in Celsius at the time the sample was taken +\item \strong{CONCENTRATION_EN}: Contains the instantaneous concentration sampled in milligrams per litre +\item \strong{SV_DEPTH2}: Depth 2 for split vertical depth integrating (m) } } \source{ @@ -43,7 +43,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_sed_samples_psd.Rd b/man/hy_sed_samples_psd.Rd index 385e6ea..e8f2265 100644 --- a/man/hy_sed_samples_psd.Rd +++ b/man/hy_sed_samples_psd.Rd @@ -5,12 +5,12 @@ \title{Extract instantaneous sediment sample particle size distribution information from the HYDAT database} \format{ A tibble with 5 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{SED_DATA_TYPE}{Contains the type of sampling method used in collecting sediment for a station} -\item{Date}{Contains the time to the nearest minute of when the sample was taken} -\item{PARTICLE_SIZE}{Particle size (mm)} -\item{PERCENT}{Contains the percentage values for indicated particle sizes for samples collected} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{SED_DATA_TYPE}: Contains the type of sampling method used in collecting sediment for a station +\item \strong{Date}: Contains the time to the nearest minute of when the sample was taken +\item \strong{PARTICLE_SIZE}: Particle size (mm) +\item \strong{PERCENT}: Contains the percentage values for indicated particle sizes for samples collected } } \source{ @@ -31,7 +31,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_src.Rd b/man/hy_src.Rd index 82f5cd6..4a91422 100644 --- a/man/hy_src.Rd +++ b/man/hy_src.Rd @@ -12,7 +12,7 @@ hy_src_disconnect(src) \arguments{ \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{src}{A as returned by \code{\link[=hy_src]{hy_src()}}.} diff --git a/man/hy_stations.Rd b/man/hy_stations.Rd index dabcdf7..4c643ec 100644 --- a/man/hy_stations.Rd +++ b/man/hy_stations.Rd @@ -5,29 +5,29 @@ \title{Extract station information from the HYDAT database} \format{ A tibble with 15 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{STATION_NAME}{Official name for station identification} -\item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -\item{REGIONAL_OFFICE_ID}{The identifier of the regional office responsible for the station. -Links to \link[tidyhydat]{hy_reg_office_list}} -\item{HYD_STATUS}{Current status of discharge or level monitoring in the hydrometric network} -\item{SED_STATUS}{Current status of sediment monitoring in the hydrometric network} -\item{LATITUDE}{North-South Coordinates of the gauging station in decimal degrees} -\item{LONGITUDE}{East-West Coordinates of the gauging station in decimal degrees} -\item{DRAINAGE_AREA_GROSS}{The total surface area that drains to the gauge site (km^2)} -\item{DRAINAGE_AREA_EFFECT}{The portion of the drainage basin that contributes runoff to +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{STATION_NAME}: Official name for station identification +\item \strong{PROV_TERR_STATE_LOC}: The province, territory or state in which the station is located +\item \strong{REGIONAL_OFFICE_ID}: The identifier of the regional office responsible for the station. +Links to \link[=hy_reg_office_list]{hy_reg_office_list} +\item \strong{HYD_STATUS}: Current status of discharge or level monitoring in the hydrometric network +\item \strong{SED_STATUS}: Current status of sediment monitoring in the hydrometric network +\item \strong{LATITUDE}: North-South Coordinates of the gauging station in decimal degrees +\item \strong{LONGITUDE}: East-West Coordinates of the gauging station in decimal degrees +\item \strong{DRAINAGE_AREA_GROSS}: The total surface area that drains to the gauge site (km^2) +\item \strong{DRAINAGE_AREA_EFFECT}: The portion of the drainage basin that contributes runoff to the gauge site, calculated by subtracting any noncontributing portion from the -gross drainage area (km^2)} -\item{RHBN}{Logical. Reference Hydrometric Basin Network station. The Reference Hydrometric +gross drainage area (km^2) +\item \strong{RHBN}: Logical. Reference Hydrometric Basin Network station. The Reference Hydrometric Basin Network (RHBN) is a sub-set of the national network that has been identified -for use in the detection, monitoring, and assessment of climate change.} -\item{REAL_TIME}{Logical. Indicates if a station has the capacity to deliver data in -real-time or near real-time} -\item{CONTRIBUTOR_ID}{Unique ID of an agency that contributes data to the -HYDAT database. The agency is non-WSC and non WSC funded} -\item{OPERATOR_ID}{Unique ID of an agency that operates a hydrometric station} -\item{DATUM_ID}{Unique ID for a datum} +for use in the detection, monitoring, and assessment of climate change. +\item \strong{REAL_TIME}: Logical. Indicates if a station has the capacity to deliver data in +real-time or near real-time +\item \strong{CONTRIBUTOR_ID}: Unique ID of an agency that contributes data to the +HYDAT database. The agency is non-WSC and non WSC funded +\item \strong{OPERATOR_ID}: Unique ID of an agency that operates a hydrometric station +\item \strong{DATUM_ID}: Unique ID for a datum } } \source{ @@ -46,7 +46,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_stn_data_coll.Rd b/man/hy_stn_data_coll.Rd index fb976b2..fed0b4a 100644 --- a/man/hy_stn_data_coll.Rd +++ b/man/hy_stn_data_coll.Rd @@ -5,15 +5,15 @@ \title{Extract station data collection from HYDAT database} \format{ A tibble with 6 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{DATA_TYPE}{The type of data} -\item{Year_from}{First year of use} -\item{Year_to}{Last year of use} -\item{MEASUREMENT}{The sampling method used in the collection of -sediment data or the type of the gauge used in the collection of the hydrometric data} -\item{OPERATION}{The schedule of station operation -for the collection of sediment or hydrometric data} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{DATA_TYPE}: The type of data +\item \strong{Year_from}: First year of use +\item \strong{Year_to}: Last year of use +\item \strong{MEASUREMENT}: The sampling method used in the collection of +sediment data or the type of the gauge used in the collection of the hydrometric data +\item \strong{OPERATION}: The schedule of station operation +for the collection of sediment or hydrometric data } } \source{ @@ -32,7 +32,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_stn_data_range.Rd b/man/hy_stn_data_range.Rd index 2d612e1..b385f02 100644 --- a/man/hy_stn_data_range.Rd +++ b/man/hy_stn_data_range.Rd @@ -5,13 +5,13 @@ \title{Extract station data range from HYDAT database} \format{ A tibble with 6 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{DATA_TYPE}{Code for the type of data} -\item{SED_DATA_TYPE}{Code for the type of instantaneous sediment data} -\item{Year_from}{First year of use} -\item{Year_to}{Last year of use} -\item{RECORD_LENGTH}{Number of years of data available in the HYDAT database} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{DATA_TYPE}: Code for the type of data +\item \strong{SED_DATA_TYPE}: Code for the type of instantaneous sediment data +\item \strong{Year_from}: First year of use +\item \strong{Year_to}: Last year of use +\item \strong{RECORD_LENGTH}: Number of years of data available in the HYDAT database } } \source{ @@ -30,7 +30,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_stn_datum_conv.Rd b/man/hy_stn_datum_conv.Rd index c73ec2b..b867d73 100644 --- a/man/hy_stn_datum_conv.Rd +++ b/man/hy_stn_datum_conv.Rd @@ -5,12 +5,12 @@ \title{Extract station datum conversions from HYDAT database} \format{ A tibble with 4 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{DATUM_FROM}{Identifying a datum from which water level is being converted} -\item{DATUM_TO}{Identifying a datum to which water level is being converted} -\item{CONVERSTION_FACTOR}{The conversion factor applied to water levels referred to -one datum to obtain water levels referred to another datum} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{DATUM_FROM}: Identifying a datum from which water level is being converted +\item \strong{DATUM_TO}: Identifying a datum to which water level is being converted +\item \strong{CONVERSTION_FACTOR}: The conversion factor applied to water levels referred to +one datum to obtain water levels referred to another datum } } \usage{ @@ -26,7 +26,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_stn_datum_unrelated.Rd b/man/hy_stn_datum_unrelated.Rd index 999b8eb..018ac9b 100644 --- a/man/hy_stn_datum_unrelated.Rd +++ b/man/hy_stn_datum_unrelated.Rd @@ -5,11 +5,11 @@ \title{Extract station datum unrelated from HYDAT database} \format{ A tibble with 4 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{DATUM_ID}{Unique code identifying a datum} -\item{Year_from}{First year of use} -\item{Year_to}{Last year of use} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{DATUM_ID}: Unique code identifying a datum +\item \strong{Year_from}: First year of use +\item \strong{Year_to}: Last year of use } } \usage{ @@ -25,7 +25,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_stn_op_schedule.Rd b/man/hy_stn_op_schedule.Rd index 725b4db..aa3d28b 100644 --- a/man/hy_stn_op_schedule.Rd +++ b/man/hy_stn_op_schedule.Rd @@ -5,12 +5,12 @@ \title{Extract station operation schedule from HYDAT database} \format{ A tibble with 6 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{DATA_TYPE}{The type of data} -\item{Year}{Year of operation schedule} -\item{Month_from}{First month of use} -\item{Month_to}{Last month of use} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{DATA_TYPE}: The type of data +\item \strong{Year}: Year of operation schedule +\item \strong{Month_from}: First month of use +\item \strong{Month_to}: Last month of use } } \source{ @@ -29,7 +29,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_stn_regulation.Rd b/man/hy_stn_regulation.Rd index 4ec43cc..41235f5 100644 --- a/man/hy_stn_regulation.Rd +++ b/man/hy_stn_regulation.Rd @@ -28,7 +28,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_stn_remarks.Rd b/man/hy_stn_remarks.Rd index bd8669b..340230f 100644 --- a/man/hy_stn_remarks.Rd +++ b/man/hy_stn_remarks.Rd @@ -5,11 +5,11 @@ \title{Extract station remarks from HYDAT database} \format{ A tibble with 4 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{REMARK_TYPE}{Type of Remark} -\item{Year}{Year of the remark} -\item{REMARK}{Remark} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{REMARK_TYPE}: Type of Remark +\item \strong{Year}: Year of the remark +\item \strong{REMARK}: Remark } } \usage{ @@ -25,7 +25,7 @@ is returned.} \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} \item{prov_terr_state_loc}{Province, state or territory. If this argument is omitted, the value of \code{station_number} diff --git a/man/hy_version.Rd b/man/hy_version.Rd index 65d9a38..b7990aa 100644 --- a/man/hy_version.Rd +++ b/man/hy_version.Rd @@ -12,7 +12,7 @@ hy_version(hydat_path = NULL) \arguments{ \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} } \value{ diff --git a/man/param_id.Rd b/man/param_id.Rd index 3b2de1a..c1c3137 100644 --- a/man/param_id.Rd +++ b/man/param_id.Rd @@ -6,12 +6,12 @@ \title{Parameter ID} \format{ A tibble with 8 rows and 7 variables: -\describe{ -\item{Parameter}{Numeric parameter code} -\item{Code}{Letter parameter code} -\item{Name_En}{Code name in English} -\item{Name_En}{Code name in French} -\item{Unit}{Parameter units} +\itemize{ +\item \strong{Parameter}: Numeric parameter code +\item \strong{Code}: Letter parameter code +\item \strong{Name_En}: Code name in English +\item \strong{Name_En}: Code name in French +\item \strong{Unit}: Parameter units } } \usage{ diff --git a/man/realtime_dd.Rd b/man/realtime_dd.Rd index ece16ac..0a39757 100644 --- a/man/realtime_dd.Rd +++ b/man/realtime_dd.Rd @@ -5,17 +5,17 @@ \title{Download a tibble of realtime river data from the last 30 days from the Meteorological Service of Canada datamart} \format{ A tibble with 8 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -\item{Date}{Observation date and time for last thirty days. Formatted as a POSIXct class in UTC for consistency.} -\item{Parameter}{Parameter being measured. Only possible values are Flow and Level} -\item{Value}{Value of the measurement. If Parameter equals Flow the units are m^3/s. -If Parameter equals Level the units are metres.} -\item{Grade}{reserved for future use} -\item{Symbol}{reserved for future use} -\item{Code}{quality assurance/quality control flag for the discharge} -\item{station_tz}{Station timezone based on tidyhydat::allstations$station_tz} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{PROV_TERR_STATE_LOC}: The province, territory or state in which the station is located +\item \strong{Date}: Observation date and time for last thirty days. Formatted as a POSIXct class in UTC for consistency. +\item \strong{Parameter}: Parameter being measured. Only possible values are Flow and Level +\item \strong{Value}: Value of the measurement. If Parameter equals Flow the units are m^3/s. +If Parameter equals Level the units are metres. +\item \strong{Grade}: reserved for future use +\item \strong{Symbol}: reserved for future use +\item \strong{Code}: quality assurance/quality control flag for the discharge +\item \strong{station_tz}: Station timezone based on tidyhydat::allstations$station_tz } } \usage{ diff --git a/man/realtime_stations.Rd b/man/realtime_stations.Rd index 85bc545..6fca306 100644 --- a/man/realtime_stations.Rd +++ b/man/realtime_stations.Rd @@ -5,13 +5,13 @@ \title{Download a tibble of active realtime stations} \format{ A tibble with 6 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{STATION_NAME}{Official name for station identification} -\item{LATITUDE}{North-South Coordinates of the gauging station in decimal degrees} -\item{LONGITUDE}{East-West Coordinates of the gauging station in decimal degrees} -\item{PROV_TERR_STATE_LOC}{The province, territory or state in which the station is located} -\item{TIMEZONE}{Timezone of the station} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{STATION_NAME}: Official name for station identification +\item \strong{LATITUDE}: North-South Coordinates of the gauging station in decimal degrees +\item \strong{LONGITUDE}: East-West Coordinates of the gauging station in decimal degrees +\item \strong{PROV_TERR_STATE_LOC}: The province, territory or state in which the station is located +\item \strong{TIMEZONE}: Timezone of the station } } \usage{ diff --git a/man/realtime_ws.Rd b/man/realtime_ws.Rd index d3bc2f5..f7ac64d 100644 --- a/man/realtime_ws.Rd +++ b/man/realtime_ws.Rd @@ -5,17 +5,17 @@ \title{Download realtime data from the ECCC web service} \format{ A tibble with 6 variables: -\describe{ -\item{STATION_NUMBER}{Unique 7 digit Water Survey of Canada station number} -\item{Date}{Observation date and time. Formatted as a POSIXct class as UTC for consistency.} -\item{Name_En}{Code name in English} -\item{Value}{Value of the measurement.} -\item{Unit}{Value units} -\item{Grade}{future use} -\item{Symbol}{future use} -\item{Approval}{future use} -\item{Parameter}{Numeric parameter code} -\item{Code}{Letter parameter code} +\itemize{ +\item \strong{STATION_NUMBER}: Unique 7 digit Water Survey of Canada station number +\item \strong{Date}: Observation date and time. Formatted as a POSIXct class as UTC for consistency. +\item \strong{Name_En}: Code name in English +\item \strong{Value}: Value of the measurement. +\item \strong{Unit}: Value units +\item \strong{Grade}: future use +\item \strong{Symbol}: future use +\item \strong{Approval}: future use +\item \strong{Parameter}: Numeric parameter code +\item \strong{Code}: Letter parameter code } } \usage{ diff --git a/man/search_stn_name.Rd b/man/search_stn_name.Rd index 6a8bda0..3dacb3e 100644 --- a/man/search_stn_name.Rd +++ b/man/search_stn_name.Rd @@ -14,7 +14,7 @@ search_stn_number(search_term, hydat_path = NULL) \item{hydat_path}{The path to the hydat database or NULL to use the default location used by \link{download_hydat}. It is also possible to pass in an existing -\link[dplyr]{src_sqlite} such that the database only needs to be opened once per +\link[dplyr:src_dbi]{src_sqlite} such that the database only needs to be opened once per user-level call.} } \value{