,
Carl James Schwarz [aut],
Sam Albers [ctb] ,
Robin Pike [ctb],
Province of British Columbia [cph]| Title: | Analyze, Summarize, and Visualize Daily Streamflow Data |
|---|---|
| Description: | The Flow Analysis Summary Statistics Tool for R, 'fasstr', provides various functions to tidy and screen daily stream discharge data, calculate and visualize various summary statistics and metrics, and compute annual trending and volume frequency analyses. It features useful function arguments for filtering of and handling dates, customizing data and metrics, and the ability to pull daily data directly from the Water Survey of Canada hydrometric database (<https://collaboration.cmc.ec.gc.ca/cmc/hydrometrics/www/>). |
| Authors: | Jon Goetz [aut, cre] ,
Carl James Schwarz [aut],
Sam Albers [ctb] ,
Robin Pike [ctb],
Province of British Columbia [cph] |
| Maintainer: | Jon Goetz <[email protected]> |
| License: | Apache License 2.0 |
| Version: | 0.5.3 |
| Built: | 2024-11-25 05:56:10 UTC |
| Source: | https://github.com/bcgov/fasstr |
Add a column of basin areas to a daily streamflow data set, in units of square kilometres.
add_basin_area(data, groups = STATION_NUMBER, station_number, basin_area)add_basin_area(data, groups = STATION_NUMBER, station_number, basin_area)
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
A tibble data frame of the original source data with an additional column:
Basin_Area_sqkm |
area of upstream drainage basin area, in square kilometres |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add the HYDAT basin area to a data frame with station numbers flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") add_basin_area(data = flow_data) # Add the HYDAT basin area to data from HYDAT add_basin_area(station_number = "08NM116") # Set a custom basin area add_basin_area(station_number = "08NM116", basin_area = 800) # Set multiple custom basin areas for multiple stations add_basin_area(station_number = c("08NM116", "08NM242"), basin_area = c("08NM116" = 800, "08NM242" = 10)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add the HYDAT basin area to a data frame with station numbers flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") add_basin_area(data = flow_data) # Add the HYDAT basin area to data from HYDAT add_basin_area(station_number = "08NM116") # Set a custom basin area add_basin_area(station_number = "08NM116", basin_area = 800) # Set multiple custom basin areas for multiple stations add_basin_area(station_number = c("08NM116", "08NM242"), basin_area = c("08NM116" = 800, "08NM242" = 10)) }
Add a column of rolling daily cumulative volumetric flows on an annual basis to a daily streamflow data set. Adds the volumetric discharge from each day with the previous day(s) for each year, in units of cubic metres. The cumulative flows restart every year and are only calculated in years with complete data.
add_cumulative_volume( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, water_year_start = 1, months = 1:12 )add_cumulative_volume( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, water_year_start = 1, months = 1:12 )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
water_year_start |
Numeric value indicating the month ( |
months |
Numeric vector of months to add cumulative flows (e.g. |
A tibble data frame of the source data with an additional column:
Cumul_Volume_m3 |
cumulative volumetric flows for each day for each year, in units of cubic metres |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column based on water years starting in August add_cumulative_volume(station_number = "08NM116", water_year_start = 8) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column based on water years starting in August add_cumulative_volume(station_number = "08NM116", water_year_start = 8) }
Add a column of rolling daily cumulative water yields on an annual basis to a daily streamflow data set. Adds the
water yields from each day with the previous day(s) for each year, in units of millimetres. Converts cumulative
discharge to a depth of water based on the upstream drainage basin area from basin_area argument. The cumulative flows
restart every year and are only calculated in years with complete data.
add_cumulative_yield( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, basin_area, water_year_start = 1, months = 1:12 )add_cumulative_yield( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, basin_area, water_year_start = 1, months = 1:12 )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
months |
Numeric vector of months to add cumulative flows. For example, |
A tibble data frame of the source data with an additional column:
Cumul_Yield_mm |
cumulative yield flows for each day for each year, in units of millimetres |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column based on water years starting in August add_cumulative_yield(station_number = "08NM116", water_year_start = 8) # Add a column based on water years starting in August with a custom basin area to calculate yield add_cumulative_yield(station_number = "08NM116", water_year_start = 8, basin_area = 800) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column based on water years starting in August add_cumulative_yield(station_number = "08NM116", water_year_start = 8) # Add a column based on water years starting in August with a custom basin area to calculate yield add_cumulative_yield(station_number = "08NM116", water_year_start = 8, basin_area = 800) }
Add a column of daily volumetric flows to a daily streamflow data set, in units of cubic metres. Converts the discharge to a volume.
add_daily_volume(data, values = Value, station_number)add_daily_volume(data, values = Value, station_number)
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
values |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
A tibble data frame of the source data with an additional column:
Volume_m3 |
daily total volumetric flow, in units of cubic metres |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column of daily flow volumes add_daily_volume(station_number = "08NM116") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column of daily flow volumes add_daily_volume(station_number = "08NM116") }
Add a column of daily water yields to a daily streamflow data set, in units of millimetres. Converts the discharge to a depth of water based on the upstream drainage basin area.
add_daily_yield( data, values = Value, groups = STATION_NUMBER, station_number, basin_area )add_daily_yield( data, values = Value, groups = STATION_NUMBER, station_number, basin_area )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
A tibble data frame of the source data with an additional column:
Yield_mm |
daily water yield, in units of millimetres |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column of yields based on HYDAT basin area add_daily_yield(station_number = "08NM116") # Add a column of yields based on a custom basin area add_daily_yield(station_number = "08NM116", basin_area = 800) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column of yields based on HYDAT basin area add_daily_yield(station_number = "08NM116") # Add a column of yields based on a custom basin area add_daily_yield(station_number = "08NM116", basin_area = 800) }
Add columns of CalendarYear (YYYY), Month (MM), MonthName (e.g. 'Jan'), WaterYear (YYYY), and DayofYear (1-365 or 366; of WaterYear); to a data frame with a column of dates called 'Date'. Water years are designated by the year in which they end. For example, Water Year 1999 (starting Oct) is from 1 Oct 1998 (DayofYear 1) to 30 Sep 1999 (DayofYear 365)).
add_date_variables(data, dates = Date, station_number, water_year_start = 1)add_date_variables(data, dates = Date, station_number, water_year_start = 1)
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
water_year_start |
Numeric value indicating the month ( |
A tibble data frame of the source data with additional columns:
CalendarYear |
calendar year |
Month |
numeric month (1 to 12) |
MonthName |
month abbreviation (Jan-Dec) |
WaterYear |
year starting from the selected month start, water_year_start |
DayofYear |
day of the year from the selected month start (1-365 or 366) |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add date variables using calendar years add_date_variables(station_number = "08NM116") # Add date variables using water years starting in August add_date_variables(station_number = "08NM116", water_year_start = 8) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add date variables using calendar years add_date_variables(station_number = "08NM116") # Add date variables using water years starting in August add_date_variables(station_number = "08NM116", water_year_start = 8) }
Adds selected n-day rolling means to a daily streamflow data set. Based on selected n-days and alignment, the rolling
mean for a given day is obtained by averaging the adjacent dates of daily mean values. For example, rolling days of '7'
and 'right' alignment would obtain a mean of the given and previous 6 days of daily mean flow.
add_rolling_means( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(3, 7, 30), roll_align = "right" )add_rolling_means( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(3, 7, 30), roll_align = "right" )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric values of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
A data frame of the source data with an additional column(s):
QnDay |
rolling means of the n-day flow values of the designated date and adjacent dates, direction of mean specified by roll_align |
Default additional columns:
Q3Day |
rolling means of the 3-day flow values of the designated date and previous 2 days (roll_align = "right") |
Q7Day |
rolling means of the 7-day flow values of the designated date and previous 6 days (roll_align = "right") |
Q30Day |
rolling means of the 30-day flow values of the designated date and previous 29 days (roll_align = "right") |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add default 3, 7, and 30-day rolling mean columns, with "right" alignment add_rolling_means(station_number = "08NM116") # Add custom 5 and 10-day rolling mean columns add_rolling_means(station_number = "08NM116", roll_days = c(5,10)) # Add default 3, 7, and 30-day rolling mean columns, with "left" alignment add_rolling_means(station_number = "08NM116", roll_align = "left") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add default 3, 7, and 30-day rolling mean columns, with "right" alignment add_rolling_means(station_number = "08NM116") # Add custom 5 and 10-day rolling mean columns add_rolling_means(station_number = "08NM116", roll_days = c(5,10)) # Add default 3, 7, and 30-day rolling mean columns, with "left" alignment add_rolling_means(station_number = "08NM116", roll_align = "left") }
Adds a column of seasons identifiers to a data frame with a column of dates called 'Date'. The length of seasons,
in months, is provided using the seasons_length argument. As seasons are grouped by months the length of the seasons
must be divisible into 12 with one of the following season lengths: 1, 2, 3, 4, 6, or 12 months. The start of the first season
coincides with the start month of each year; 'Jan-Jun' for 6-month seasons starting with calendar years or 'Dec-Feb' for 3-month
seasons starting with water year starting in December.
add_seasons( data, dates = Date, station_number, water_year_start = 1, seasons_length )add_seasons( data, dates = Date, station_number, water_year_start = 1, seasons_length )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
water_year_start |
Numeric value indicating the month ( |
seasons_length |
Numeric value indicating the desired length of seasons in months, divisible into 12. Required. |
A tibble data frame of the source data with additional column:
Season |
season identifier labelled by the start and end month of the season |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column with four annual seasons starting in January add_seasons(station_number = "08NM116", seasons_length = 4) # Add a column with two annual seasons (of 6 months length) starting in October add_seasons(station_number = "08NM116", water_year_start = 10, seasons_length = 6) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Add a column with four annual seasons starting in January add_seasons(station_number = "08NM116", seasons_length = 4) # Add a column with two annual seasons (of 6 months length) starting in October add_seasons(station_number = "08NM116", water_year_start = 10, seasons_length = 6) }
Calculates annual statistics from all annual fasstr functions from a daily streamflow data set.
Data is ideally long-term and continuous with minimal missing/seasonal data as annual statistics are calculated.
Calculates statistics from all values, unless specified. Returns a tibble with statistics.
Data calculated using the following functions:
calc_annual_stats()
calc_annual_lowflows()
calc_annual_cumulative_stats()
calc_annual_flow_timing()
calc_annual_normal_days()
calc_monthly_stats()
calc_all_annual_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, annual_percentiles = c(10, 90), monthly_percentiles = c(10, 20), stats_days = 1, stats_align = "right", lowflow_days = c(1, 3, 7, 30), lowflow_align = "right", timing_percent = c(25, 33, 50, 75), normal_percentiles = c(25, 75), transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0) )calc_all_annual_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, annual_percentiles = c(10, 90), monthly_percentiles = c(10, 20), stats_days = 1, stats_align = "right", lowflow_days = c(1, 3, 7, 30), lowflow_align = "right", timing_percent = c(25, 33, 50, 75), normal_percentiles = c(25, 75), transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
annual_percentiles |
Numeric vector of percentiles to calculate annually. Set to |
monthly_percentiles |
Numeric vector of percentiles to calculate monthly for each year. Set to |
stats_days |
Numeric vector of the number of days to apply a rolling mean on basic stats. Default |
stats_align |
Character string identifying the direction of the rolling mean on basic stats from the specified date, either by
the first ( |
lowflow_days |
Numeric vector of the number of days to apply a rolling mean on low flow stats. Default |
lowflow_align |
Character string identifying the direction of the rolling mean on low flow stats from the specified date,
either by the first ( |
timing_percent |
Numeric vector of percents of annual total flows to determine dates. Used for |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing_annual |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate an annual statistic (0 to 100 percent). If |
allowed_missing_monthly |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a monthly statistic (0 to 100 percent). If |
A tibble data frame with column "Year" and then 107 (default) variables from the fasstr annual functions. See listed functions above for default variables. Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
calc_annual_stats,
calc_annual_lowflows,
calc_annual_cumulative_stats,
calc_annual_flow_timing,
calc_monthly_stats,
calc_annual_normal_days
## Not run: # Working examples: # Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate all annual statistics from this package with default arguments calc_all_annual_stats(station_number = "08NM116") # Calculate all annual statistics from this package with default arguments # with some default arguments shown to customize metrics calc_all_annual_stats(station_number = "08NM116", annual_percentiles = c(10,90), monthly_percentiles = c(10,20), stats_days = 1, stats_align = "right", lowflow_days = c(1,3,7,30), lowflow_align = "right", timing_percent = c(25,33,50,75), normal_percentiles = c(25,75)) } ## End(Not run)## Not run: # Working examples: # Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate all annual statistics from this package with default arguments calc_all_annual_stats(station_number = "08NM116") # Calculate all annual statistics from this package with default arguments # with some default arguments shown to customize metrics calc_all_annual_stats(station_number = "08NM116", annual_percentiles = c(10,90), monthly_percentiles = c(10,20), stats_days = 1, stats_align = "right", lowflow_days = c(1,3,7,30), lowflow_align = "right", timing_percent = c(25,33,50,75), normal_percentiles = c(25,75)) } ## End(Not run)
Calculates annual and seasonal total flows, as volumetric discharge or water yields, from a daily streamflow data set. For water year and seasonal data, the year is identified by the year in which the year or season ends. Two-seasons and four-seasons per year are calculated, with each 6 and 3-month seasons starting with the first month of the year (Jan for calendar year, specified for water year). Each season is designated by the calendar or water year in which it occurs. Calculates statistics from all values from complete years, unless specified. Returns a tibble with statistics.
calc_annual_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_seasons = FALSE, transpose = FALSE, complete_years = FALSE )calc_annual_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_seasons = FALSE, transpose = FALSE, complete_years = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
use_yield |
Logical value indicating whether to calculate area-based water yield, in mm, instead of volumetric discharge.
Default |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis (e.g. |
include_seasons |
Logical value indication whether to include seasonal yields or volumetric discharges. Default |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
A tibble data frame with the following columns, ending with '_Volume_m3' or '_Yield_mm' based on selection:
Year |
calendar or water year selected |
Total_* |
annual (or selected months) total flow, in m3 or mm |
Default seasonal columns:
MMM-MMM_* |
first of two season total flows, in m3 or mm |
MMM-MMM_* |
second of two season total flows, in m3 or mm |
MMM-MMM_* |
first of four season total flows, in m3 or mm |
MMM-MMM_* |
second of four season total flows, in m3 or mm |
MMM-MMM_* |
third of four season total flows, in m3 or mm |
MMM-MMM_* |
fourth of four season total flows, in m3 or mm |
Transposing data creates a column of 'Statistics' and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual total volumetric flow statistics calc_annual_cumulative_stats(station_number = "08NM116") # Calculate annual total yield statistics with default HYDAT basin area calc_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Calculate annual total yield statistics with a custom basin area calc_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800, start_year = 1980) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual total volumetric flow statistics calc_annual_cumulative_stats(station_number = "08NM116") # Calculate annual total yield statistics with default HYDAT basin area calc_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Calculate annual total yield statistics with a custom basin area calc_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800, start_year = 1980) }
Calculates annual n-day minimum and maximum values, and the day of year and date of occurrence of daily flow values from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_annual_extremes( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_days_min = NA, roll_days_max = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_min = NA, months_max = NA, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )calc_annual_extremes( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_days_min = NA, roll_days_max = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_min = NA, months_max = NA, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_days_min |
Numeric value of the number of days to apply a rolling mean for low flows. Will override 'roll_days' argument
for low flows. Default |
roll_days_max |
Numeric value of the number of days to apply a rolling mean for high flows. Will override 'roll_days' argument
for high flows. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
months_min |
Numeric vector of specified months for window of low flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for low flows. Default |
months_max |
Numeric vector of specified months for window of high flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for high flows. Default |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Min_'n'_Day |
annual minimum for selected n-day rolling mean, direction of mean specified by roll_align |
Min_'n'_Day_DoY |
day of year for selected annual minimum of n-day rolling mean |
Min_'n'_Day_Date |
date (YYYY-MM-DD) for selected annual minimum of n-day rolling mean |
Max_'n'_Day |
annual maximum for selected n-day rolling mean, direction of mean specified by roll_align |
Max_'n'_Day_DoY |
day of year for selected annual maximum of n-day rolling mean |
Max_'n'_Day_Date |
date (YYYY-MM-DD) for selected annual maximum of n-day rolling mean |
Default columns:
Min_1_Day |
annual 1-day mean minimum (roll_align = right) |
Min_1_Day_DoY |
day of year of annual 1-day mean minimum |
Min_1_Day_Date |
date (YYYY-MM-DD) of annual 1-day mean minimum |
Max_1_Day |
annual 1-day mean maximum (roll_align = right) |
Max_1_Day_DoY |
day of year of annual 1-day mean maximum |
Max_1_Day_Date |
date (YYYY-MM-DD) of annual 1-day mean maximum |
Transposing data creates a column of 'Statistics' and subsequent columns for each year selected. 'Date' statistics not transposed.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1-day (default) max/min flow data with # default alignment ('right') calc_annual_extremes(station_number = "08NM116") # Calculate custom 3-day max/min flow data with 'center' alignment calc_annual_extremes(station_number = "08NM116", roll_days = 3, roll_align = "center", start_year = 1980) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1-day (default) max/min flow data with # default alignment ('right') calc_annual_extremes(station_number = "08NM116") # Calculate custom 3-day max/min flow data with 'center' alignment calc_annual_extremes(station_number = "08NM116", roll_days = 3, roll_align = "center", start_year = 1980) }
Calculates the timing (day of year and date) of portions of total annual flow of daily flow values from a daily streamflow data set. Calculates statistics from all values from complete years, unless specified. Returns a tibble with statistics.
calc_annual_flow_timing( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percent_total = c(25, 33.3, 50, 75), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )calc_annual_flow_timing( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percent_total = c(25, 33.3, 50, 75), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percent_total |
Numeric vector of percents of total annual flows to determine dates. Default |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
DoY_'n'pct_TotalQ |
day of year for each n-percent of total volumetric discharge |
Date_'n'pct_TotalQ |
date (YYYY-MM-DD) for each n-percent of total volumetric discharge |
Default columns:
DoY_25pct_TotalQ |
day of year of 25-percent of total volumetric discharge |
Date_25pct_TotalQ |
date (YYYY-MM-DD) of 25-percent of total volumetric discharge |
DoY_33.3pct_TotalQ |
day of year of 33.3-percent of total volumetric discharge |
Date_33.3pct_TotalQ |
date (YYYY-MM-DD) of 33.3-percent of total volumetric discharge |
DoY_50pct_TotalQ |
day of year of 50-percent of total volumetric discharge |
Date_50pct_TotalQ |
date (YYYY-MM-DD) of 50-percent of total volumetric discharge |
DoY_75pct_TotalQ |
day of year of 75-percent of total volumetric discharge |
Date_75pct_TotalQ |
date (YYYY-MM-DD) of 75-percent of total volumetric discharge |
Transposing data creates a column of 'Statistics' (just DoY, not Date values) and subsequent columns for each year selected.
Barnett, T.P., Pierce, D.W., Hidalgo, H.G., Bonfils, C., Santer, B.D., Das, T., Bala, G., Wood, A.W., Nozawa, T., Mirin, A.A., Cayan, D.R., Dettinger, M.D., 2008. Human-Induced Clanges in the Hydrology of the Western United States. Science 319, 1080-1083.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual flow timings with default percent of annual totals calc_annual_flow_timing(station_number = "08NM116") # Calculate annual flow timings with custom percent of annual totals calc_annual_flow_timing(station_number = "08NM116", percent_total = 50) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual flow timings with default percent of annual totals calc_annual_flow_timing(station_number = "08NM116") # Calculate annual flow timings with custom percent of annual totals calc_annual_flow_timing(station_number = "08NM116", percent_total = 50) }
Calculates annual n-day maximum values, and the day of year and date of occurrence of daily flow values from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_annual_highflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )calc_annual_highflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Max_'n'_Day |
annual maximum for each n-day rolling mean, direction of mean specified by roll_align |
Max_'n'_Day_DoY |
day of year for each annual maximum of n-day rolling mean |
Max_'n'_Day_Date |
date (YYYY-MM-DD) for each annual maximum of n-day rolling mean |
Default columns:
Max_1_Day |
annual 1-day mean maximum (roll_align = right) |
Max_1_Day_DoY |
day of year of annual 1-day mean maximum |
Max_1_Day_Date |
date (YYYY-MM-DD) of annual 1-day mean maximum |
Max_3_Day |
annual 3-day mean maximum (roll_align = right) |
Max_3_Day_DoY |
day of year of annual 3-day mean maximum |
Max_3_Day_Date |
date (YYYY-MM-DD) of annual 3-day mean maximum |
Max_7_Day |
annual 7-day mean maximum (roll_align = right) |
Max_7_Day_DoY |
day of year of annual 7-day mean maximum |
Max_7_Day_Date |
date (YYYY-MM-DD) of annual 7-day mean maximum |
Max_30_Day |
annual 30-day mean maximum (roll_align = right) |
Max_30_Day_DoY |
day of year of annual 30-day mean maximum |
Max_30_Day_Date |
date (YYYY-MM-DD) of annual 30-day mean maximum |
Transposing data creates a column of 'Statistics' and subsequent columns for each year selected. 'Date' statistics not transposed.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1, 3, 7, and 30-day (default) high flows with # default alignment ('right') calc_annual_highflows(station_number = "08NM116") # Calculate custom 3 and 7-day annual high flows with 'center' alignment calc_annual_highflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center", start_year = 1980) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1, 3, 7, and 30-day (default) high flows with # default alignment ('right') calc_annual_highflows(station_number = "08NM116") # Calculate custom 3 and 7-day annual high flows with 'center' alignment calc_annual_highflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center", start_year = 1980) }
Calculates annual n-day minimum values, and the day of year and date of occurrence of daily flow values from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_annual_lowflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )calc_annual_lowflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Min_'n'_Day |
annual minimum for each n-day rolling mean, direction of mean specified by roll_align |
Min_'n'_Day_DoY |
day of year for each annual minimum of n-day rolling mean |
Min_'n'_Day_Date |
date (YYYY-MM-DD) for each annual minimum of n-day rolling mean |
Default columns:
Min_1_Day |
annual 1-day mean minimum (roll_align = right) |
Min_1_Day_DoY |
day of year of annual 1-day mean minimum |
Min_1_Day_Date |
date (YYYY-MM-DD) of annual 1-day mean minimum |
Min_3_Day |
annual 3-day mean minimum (roll_align = right) |
Min_3_Day_DoY |
day of year of annual 3-day mean minimum |
Min_3_Day_Date |
date (YYYY-MM-DD) of annual 3-day mean minimum |
Min_7_Day |
annual 7-day mean minimum (roll_align = right) |
Min_7_Day_DoY |
day of year of annual 7-day mean minimum |
Min_7_Day_Date |
date (YYYY-MM-DD) of annual 7-day mean minimum |
Min_30_Day |
annual 30-day mean minimum (roll_align = right) |
Min_30_Day_DoY |
day of year of annual 30-day mean minimum |
Min_30_Day_Date |
date (YYYY-MM-DD) of annual 30-day mean minimum |
Transposing data creates a column of 'Statistics' and subsequent columns for each year selected. 'Date' statistics not transposed.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1, 3, 7, and 30-day (default) low flows with # default alignment ('right') calc_annual_lowflows(station_number = "08NM116") # Calculate custom 3 and 7-day annual low flows with 'center' alignment calc_annual_lowflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center", start_year = 1980) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1, 3, 7, and 30-day (default) low flows with # default alignment ('right') calc_annual_lowflows(station_number = "08NM116") # Calculate custom 3 and 7-day annual low flows with 'center' alignment calc_annual_lowflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center", start_year = 1980) }
Calculates the number of days per year outside of the 'normal' range (typically between 25 and 75th percentiles) for each day of the year. Upper and lower-range percentiles are calculated for each day of the year of from all years, and then each daily flow value for each year is compared. All days above or below the normal range are included. Analysis methodology is based on Environment and Climate Change Canada's Water Quantity indicator from the Canadian Environmental Sustainability Indicators. Calculates statistics from all values from complete years, unless specified. Returns a tibble with statistics.
calc_annual_normal_days( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )calc_annual_normal_days( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Below_Normal_Days |
number of days per year below the daily normal (default 25th percentile) |
Above_Normal_Days |
number of days per year above the daily normal (default 75th percentile) |
Days_Outside_Normal |
number of days per year below and above the daily normal (default 25/75th percentile) |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate statistics with default limits of normal (25 and 75th percentiles) calc_annual_normal_days(station_number = "08NM116") # Calculate statistics with custom limits of normal calc_annual_normal_days(station_number = "08NM116", normal_percentiles = c(10,90), start_year = 1980) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate statistics with default limits of normal (25 and 75th percentiles) calc_annual_normal_days(station_number = "08NM116") # Calculate statistics with custom limits of normal calc_annual_normal_days(station_number = "08NM116", normal_percentiles = c(10,90), start_year = 1980) }
This function has been superseded by the calc_annual_normal_days() function.
Calculates the number of days per year outside of the 'normal' range (typically between 25 and 75th percentiles) for each day of the year. Upper and lower-range percentiles are calculated for each day of the year of from all years, and then each daily flow value for each year is compared. All days above or below the normal range are included. Analysis methodology is based on Environment and Climate Change Canada's Water Quantity indicator from the Canadian Environmental Sustainability Indicators. Calculates statistics from all values from complete years, unless specified. Returns a tibble with statistics.
calc_annual_outside_normal( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )calc_annual_outside_normal( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Days_Below_Normal |
number of days per year below the daily normal (default 25th percentile) |
Days_Above_Normal |
number of days per year above the daily normal (default 75th percentile) |
Days_Outside_Normal |
number of days per year below and above the daily normal (default 25/75th percentile) |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate statistics with default limits of normal (25 and 75th percentiles) calc_annual_outside_normal(station_number = "08NM116") # Calculate statistics with custom limits of normal calc_annual_outside_normal(station_number = "08NM116", normal_percentiles = c(10,90)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate statistics with default limits of normal (25 and 75th percentiles) calc_annual_outside_normal(station_number = "08NM116") # Calculate statistics with custom limits of normal calc_annual_outside_normal(station_number = "08NM116", normal_percentiles = c(10,90)) }
This function has been superseded by the calc_annual_extremes() function.
Calculates annual n-day minimum and maximum values, and the day of year and date of occurrence of daily flow values from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_annual_peaks( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_days_low = NA, roll_days_high = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_low = NA, months_high = NA, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )calc_annual_peaks( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_days_low = NA, roll_days_high = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_low = NA, months_high = NA, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_days_low |
Numeric value of the number of days to apply a rolling mean for low flows. Will override 'roll_days' argument
for low flows. Default |
roll_days_high |
Numeric value of the number of days to apply a rolling mean for high flows. Will override 'roll_days' argument
for high flows. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
months_low |
Numeric vector of specified months for window of low flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for low flows. Default |
months_high |
Numeric vector of specified months for window of high flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for high flows. Default |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Min_'n'_Day |
annual minimum for selected n-day rolling mean, direction of mean specified by roll_align |
Min_'n'_Day_DoY |
day of year for selected annual minimum of n-day rolling mean |
Min_'n'_Day_Date |
date (YYYY-MM-DD) for selected annual minimum of n-day rolling mean |
Max_'n'_Day |
annual maximum for selected n-day rolling mean, direction of mean specified by roll_align |
Max_'n'_Day_DoY |
day of year for selected annual maximum of n-day rolling mean |
Max_'n'_Day_Date |
date (YYYY-MM-DD) for selected annual maximum of n-day rolling mean |
Default columns:
Min_1_Day |
annual 1-day mean minimum (roll_align = right) |
Min_1_Day_DoY |
day of year of annual 1-day mean minimum |
Min_1_Day_Date |
date (YYYY-MM-DD) of annual 1-day mean minimum |
Max_1_Day |
annual 1-day mean maximum (roll_align = right) |
Max_1_Day_DoY |
day of year of annual 1-day mean maximum |
Max_1_Day_Date |
date (YYYY-MM-DD) of annual 1-day mean maximum |
Transposing data creates a column of 'Statistics' and subsequent columns for each year selected. 'Date' statistics not transposed.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1-day (default) peak flow data with # default alignment ('right') calc_annual_peaks(station_number = "08NM116") # Calculate custom 3-day peak flow data with 'center' alignment calc_annual_peaks(station_number = "08NM116", roll_days = 3, roll_align = "center") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual 1-day (default) peak flow data with # default alignment ('right') calc_annual_peaks(station_number = "08NM116") # Calculate custom 3-day peak flow data with 'center' alignment calc_annual_peaks(station_number = "08NM116", roll_days = 3, roll_align = "center") }
Calculates means, medians, maximums, minimums, and percentiles for each year from all years of a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_annual_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", percentiles = c(10, 90), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )calc_annual_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", percentiles = c(10, 90), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
percentiles |
Numeric vector of percentiles to calculate. Set to |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Mean |
annual mean of all daily flows for a given year |
Median |
annual median of all daily flows for a given year |
Maximum |
annual maximum of all daily flows for a given year |
Minimum |
annual minimum of all daily flows for a given year |
P'n' |
each annual n-th percentile selected of all daily flows |
Default percentile columns:
P10 |
annual 10th percentile of all daily flows for a given year |
P90 |
annual 90th percentile of all daily flows for a given year |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual statistics from a data frame using the data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_annual_stats(data = flow_data) # Calculate annual statistics using station_number argument calc_annual_stats(station_number = "08NM116") # Calculate annual statistics regardless if there # is missing data for a given year calc_annual_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate annual statistics for water years starting in October calc_annual_stats(station_number = "08NM116", water_year_start = 10) # Calculate annual statistics for 7-day flows for July-September # months only, with 25 and 75th percentiles calc_annual_stats(station_number = "08NM116", roll_days = 7, months = 7:9, percentiles = c(25,75)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual statistics from a data frame using the data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_annual_stats(data = flow_data) # Calculate annual statistics using station_number argument calc_annual_stats(station_number = "08NM116") # Calculate annual statistics regardless if there # is missing data for a given year calc_annual_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate annual statistics for water years starting in October calc_annual_stats(station_number = "08NM116", water_year_start = 10) # Calculate annual statistics for 7-day flows for July-September # months only, with 25 and 75th percentiles calc_annual_stats(station_number = "08NM116", roll_days = 7, months = 7:9, percentiles = c(25,75)) }
Calculate cumulative daily flow statistics for each day of the year of daily flow values from a daily streamflow
data set. Defaults to volumetric cumulative flows, can use use_yield and basin_area to convert to area-based
water yield. Calculates statistics from all values from all complete years, unless specified. Returns a tibble with statistics.
calc_daily_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(5, 25, 75, 95), use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )calc_daily_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(5, 25, 75, 95), use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
use_yield |
Logical value indicating whether to calculate area-based water yield, in mm, instead of volumetric discharge.
Default |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
A data frame with the following columns, default units in cubic metres, millimetres if use_yield and basin_area provided:
Date |
date (MMM-DD) of daily cumulative statistics |
DayofYear |
day of year of daily cumulative statistics |
Mean |
daily mean of all cumulative flows for a given day of the year |
Median |
daily mean of all cumulative flows for a given day of the year |
Maximum |
daily mean of all cumulative flows for a given day of the year |
Minimum |
daily mean of all cumulative flows for a given day of the year |
P'n' |
each daily n-th percentile selected of all cumulative flows for a given day of the year |
Default percentile columns:
P5 |
daily 5th percentile of all cumulative flows for a given day of the year |
P25 |
daily 25th percentile of all cumulative flows for a given day of the year |
P75 |
daily 75th percentile of all cumulative flows for a given day of the year |
P95 |
daily 95th percentile of all cumulative flows for a given day of the year |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual daily cumulative yield statistics # with default HYDAT basin area calc_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Calculate annual daily cumulative yield statistics # with custom basin area calc_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual daily cumulative yield statistics # with default HYDAT basin area calc_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Calculate annual daily cumulative yield statistics # with custom basin area calc_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }
Calculates means, medians, maximums, minimums, and percentiles for each day of the year of flow values
from a daily streamflow data set. Can determine statistics of rolling mean days (e.g. 7-day flows) using the roll_days
argument. Note that statistics are based on the numeric days of year (1-365) and not the date of year (Jan 1 - Dec 31).
Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(5, 25, 75, 95), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE )calc_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(5, 25, 75, 95), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, complete_years = FALSE, ignore_missing = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
A tibble data frame with the following columns:
Date |
date (MMM-DD) of daily statistics |
DayofYear |
day of year of daily statistics |
Mean |
daily mean of all flows for a given day of the year |
Median |
daily mean of all flows for a given day of the year |
Maximum |
daily mean of all flows for a given day of the year |
Minimum |
daily mean of all flows for a given day of the year |
P'n' |
each daily n-th percentile selected of all flows for a given day of the year |
Default percentile columns:
P5 |
daily 5th percentile of all flows for a given day of the year |
P25 |
daily 25th percentile of all flows for a given day of the year |
P75 |
daily 75th percentile of all flows for a given day of the year |
P95 |
daily 95th percentile of all flows for a given day of the year |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate daily statistics using station_number argument with defaults calc_daily_stats(station_number = "08NM116", start_year = 1980) # Calculate daily statistics regardless if there is missing data for a given day of year calc_daily_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate daily statistics using only years with no missing data calc_daily_stats(station_number = "08NM116", complete_years = TRUE) # Calculate daily statistics for water years starting in October between 1980 and 2010 calc_daily_stats(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate daily statistics using station_number argument with defaults calc_daily_stats(station_number = "08NM116", start_year = 1980) # Calculate daily statistics regardless if there is missing data for a given day of year calc_daily_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate daily statistics using only years with no missing data calc_daily_stats(station_number = "08NM116", complete_years = TRUE) # Calculate daily statistics for water years starting in October between 1980 and 2010 calc_daily_stats(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10) }
Calculates the percentile rank of a discharge value compared to all flow values of a streamflow data set.
Looks up the value in the distribution (stats::ecdf() function) of all daily discharge values from all years, unless
specified. Returns a tibble with statistics.
calc_flow_percentile( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", flow_value, water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12 )calc_flow_percentile( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", flow_value, water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12 )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
flow_value |
A numeric flow value of which to determine the percentile rank. Required. |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
months |
Numeric vector of months to include in analysis. For example, |
A tibble data frame, or a single numeric value if no station number provided, of the percentile rank of a given flow value.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate the percentile rank of a 10-cms flow value from a full record calc_flow_percentile(station_number = "08NM116", flow_value = 10) # Calculate the percentile rank of a 10-cms flow value from years with no missing data calc_flow_percentile(station_number = "08NM116", complete_years = TRUE, flow_value = 10) # Calculate the percentile rank of a 10-cms flow value for June from years with no missing data calc_flow_percentile(station_number = "08NM116", complete_years = TRUE, months = 6, flow_value = 10) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate the percentile rank of a 10-cms flow value from a full record calc_flow_percentile(station_number = "08NM116", flow_value = 10) # Calculate the percentile rank of a 10-cms flow value from years with no missing data calc_flow_percentile(station_number = "08NM116", complete_years = TRUE, flow_value = 10) # Calculate the percentile rank of a 10-cms flow value for June from years with no missing data calc_flow_percentile(station_number = "08NM116", complete_years = TRUE, months = 6, flow_value = 10) }
Calculates the long-term mean, median, maximum, minimum, and percentiles of daily flow values for over all months and all data (Long-term) from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_longterm_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(10, 90), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, include_longterm = TRUE, custom_months, custom_months_label, transpose = FALSE, ignore_missing = FALSE )calc_longterm_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(10, 90), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, include_longterm = TRUE, custom_months, custom_months_label, transpose = FALSE, ignore_missing = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
include_longterm |
Logical value indicating whether to include long-term calculation of all data. Default |
custom_months |
Numeric vector of months to combine to summarize (ex. |
custom_months_label |
Character string to label custom months. For example, if |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
A tibble data frame with the following columns:
Month |
month of the year, included 'Long-term' for all months, and 'Custom-Months' if selected |
Mean |
mean of all daily data for a given month and long-term over all years |
Median |
median of all daily data for a given month and long-term over all years |
Maximum |
maximum of all daily data for a given month and long-term over all years |
Minimum |
minimum of all daily data for a given month and long-term over all years |
P'n' |
each n-th percentile selected for a given month and long-term over all years |
Default percentile columns:
P10 |
annual 10th percentile selected for a given month and long-term over all years |
P90 |
annual 90th percentile selected for a given month and long-term over all years |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate long-term statistics using data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_longterm_daily_stats(data = flow_data, start_year = 1980) # Calculate long-term statistics using station_number argument with defaults calc_longterm_daily_stats(station_number = "08NM116", start_year = 1980) # Calculate long-term statistics regardless if there is missing data for a given year calc_longterm_daily_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate long-term statistics for water years starting in October calc_longterm_daily_stats(station_number = "08NM116", start_year = 1980, water_year_start = 10) # Calculate long-term statistics with custom years and percentiles calc_longterm_daily_stats(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995), percentiles = c(25,75)) # Calculate long-term statistics and add custom stats for July-September calc_longterm_daily_stats(station_number = "08NM116", start_year = 1980, custom_months = 7:9, custom_months_label = "Summer") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate long-term statistics using data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_longterm_daily_stats(data = flow_data, start_year = 1980) # Calculate long-term statistics using station_number argument with defaults calc_longterm_daily_stats(station_number = "08NM116", start_year = 1980) # Calculate long-term statistics regardless if there is missing data for a given year calc_longterm_daily_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate long-term statistics for water years starting in October calc_longterm_daily_stats(station_number = "08NM116", start_year = 1980, water_year_start = 10) # Calculate long-term statistics with custom years and percentiles calc_longterm_daily_stats(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995), percentiles = c(25,75)) # Calculate long-term statistics and add custom stats for July-September calc_longterm_daily_stats(station_number = "08NM116", start_year = 1980, custom_months = 7:9, custom_months_label = "Summer") }
Calculates the long-term mean annual discharge (MAD) from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_longterm_mean( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12, percent_MAD, transpose = FALSE )calc_longterm_mean( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12, percent_MAD, transpose = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
months |
Numeric vector of months to include in analysis. For example, |
percent_MAD |
Numeric vector of percents of long-term mean annual discharge to add to the table (ex. |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
A tibble data frame of numeric values of a long-term mean (and percent of long-term mean if selected) of selected years and months.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate the long-term mean annual discharge (MAD) using only years with no missing data calc_longterm_mean(station_number = "08NM116", complete_years = TRUE) # Calculate the long-term MAD and 5, 10 and 20-percent MADs using only years with no missing data calc_longterm_mean(station_number = "08NM116", complete_years = TRUE, percent_MAD = c(5,10,20)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate the long-term mean annual discharge (MAD) using only years with no missing data calc_longterm_mean(station_number = "08NM116", complete_years = TRUE) # Calculate the long-term MAD and 5, 10 and 20-percent MADs using only years with no missing data calc_longterm_mean(station_number = "08NM116", complete_years = TRUE, percent_MAD = c(5,10,20)) }
Calculates the long-term mean, median, maximum, minimum, and percentiles of annual monthly mean flow values for all months and all data (Long-term) from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_longterm_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(10, 90), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, include_annual = TRUE, custom_months, custom_months_label, transpose = FALSE, ignore_missing = FALSE )calc_longterm_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(10, 90), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, include_annual = TRUE, custom_months, custom_months_label, transpose = FALSE, ignore_missing = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
include_annual |
Logical value indicating whether to include annual calculation of all months. Default |
custom_months |
Numeric vector of months to combine to summarize (ex. |
custom_months_label |
Character string to label custom months. For example, if |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
A tibble data frame with the following columns:
Month |
month of the year, included 'Annual' for all months, and 'Custom-Months' if selected |
Mean |
mean of all annual monthly means for a given month over all years |
Median |
median of all annual monthly means for a given month over all years |
Maximum |
maximum of all annual monthly means for a given month over all years |
Minimum |
minimum of all annual monthly means for a given month over all years |
P'n' |
each n-th percentile selected for annual monthly means for a given month over all years |
Default percentile columns:
P10 |
annual 10th percentile selected for annual monthly means for a given month over all years |
P90 |
annual 90th percentile selected for annual monthly means for a given month over all years |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate long-term monthly statistics using data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_longterm_monthly_stats(data = flow_data, start_year = 1980) # Calculate long-term monthly statistics using station_number argument with defaults calc_longterm_monthly_stats(station_number = "08NM116", start_year = 1980) # Calculate long-term monthly statistics regardless if there is missing data for a given year calc_longterm_monthly_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate long-term monthly statistics and add custom stats for July-September calc_longterm_monthly_stats(station_number = "08NM116", start_year = 1980, custom_months = 7:9, custom_months_label = "Summer") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate long-term monthly statistics using data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_longterm_monthly_stats(data = flow_data, start_year = 1980) # Calculate long-term monthly statistics using station_number argument with defaults calc_longterm_monthly_stats(station_number = "08NM116", start_year = 1980) # Calculate long-term monthly statistics regardless if there is missing data for a given year calc_longterm_monthly_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate long-term monthly statistics and add custom stats for July-September calc_longterm_monthly_stats(station_number = "08NM116", start_year = 1980, custom_months = 7:9, custom_months_label = "Summer") }
Calculates the long-term percentiles from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_longterm_percentile( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12, transpose = FALSE )calc_longterm_percentile( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12, transpose = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles (ex. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
A tibble data frame of a long-term percentile of selected years and months.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate the 20th percentile flow value from a flow record calc_longterm_percentile(station_number = "08NM116", percentile = 20) # Calculate the 90th percentile flow value with custom years calc_longterm_percentile(station_number = "08NM116", start_year = 1980, end_year = 2010, percentile = 90) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate the 20th percentile flow value from a flow record calc_longterm_percentile(station_number = "08NM116", percentile = 20) # Calculate the 90th percentile flow value with custom years calc_longterm_percentile(station_number = "08NM116", start_year = 1980, end_year = 2010, percentile = 90) }
Calculate cumulative monthly flow statistics for each month of the year of daily flow values from a daily streamflow
data set. Calculates statistics from all values from complete years, unless specified. Defaults to volumetric cumulative flows,
can use use_yield and basin_area to convert to area-based water yield. Returns a tibble with statistics.
calc_monthly_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(5, 25, 75, 95), use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )calc_monthly_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(5, 25, 75, 95), use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
use_yield |
Logical value indicating whether to calculate area-based water yield, in mm, instead of volumetric discharge.
Default |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
A tibble data frame with the following columns, default units in cubic metres, or millimetres if use_yield and basin_area provided:
Month |
month (MMM-DD) of cumulative statistics |
Mean |
monthly mean of all cumulative flows for a given month of the year |
Median |
monthly mean of all cumulative flows for a given month of the year |
Maximum |
monthly mean of all cumulative flows for a given month of the year |
Minimum |
monthly mean of all cumulative flows for a given month of the year |
P'n' |
each monthly n-th percentile selected of all cumulative flows for a given month of the year |
Default percentile columns:
P5 |
monthly 5th percentile of all cumulative flows for a given month of the year |
P25 |
monthly 25th percentile of all cumulative flows for a given month of the year |
P75 |
monthly 75th percentile of all cumulative flows for a given month of the year |
P95 |
monthly 95th percentile of all cumulative flows for a given month of the year |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual monthly cumulative volume statistics calc_monthly_cumulative_stats(station_number = "08NM116") # Calculate annual monthly cumulative volume statistics with default HYDAT basin area calc_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Calculate annual monthly cumulative volume statistics with custom basin area calc_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual monthly cumulative volume statistics calc_monthly_cumulative_stats(station_number = "08NM116") # Calculate annual monthly cumulative volume statistics with default HYDAT basin area calc_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Calculate annual monthly cumulative volume statistics with custom basin area calc_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }
Calculates means, medians, maximums, minimums, and percentiles for each month of all years of flow values from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
calc_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(10, 90), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, spread = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )calc_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles = c(10, 90), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, transpose = FALSE, spread = FALSE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating if each month statistic should be individual rows. Default |
spread |
Logical value indicating if each month statistic should be the column name. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
Month |
month of the year |
Mean |
mean of all daily flows for a given month and year |
Median |
median of all daily flows for a given month and year |
Maximum |
maximum of all daily flows for a given month and year |
Minimum |
minimum of all daily flows for a given month and year |
P'n' |
each n-th percentile selected for a given month and year |
Default percentile columns:
P10 |
10th percentile of all daily flows for a given month and year |
P90 |
90th percentile of all daily flows for a given month and year |
Transposing data creates a column of 'Statistics' for each month, labeled as 'Month-Statistic' (ex "Jan-Mean"), and subsequent columns for each year selected. Spreading data creates columns of Year and subsequent columns of Month-Statistics (ex 'Jan-Mean').
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_monthly_stats(data = flow_data, start_year = 1980) # Calculate statistics using station_number argument with defaults calc_monthly_stats(station_number = "08NM116", start_year = 1980) # Calculate statistics regardless if there is missing data for a given year calc_monthly_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate statistics for water years starting in October calc_monthly_stats(station_number = "08NM116", start_year = 1980, water_year_start = 10) # Calculate statistics with custom years and percentiles calc_monthly_stats(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995), percentiles = c(25,75)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") calc_monthly_stats(data = flow_data, start_year = 1980) # Calculate statistics using station_number argument with defaults calc_monthly_stats(station_number = "08NM116", start_year = 1980) # Calculate statistics regardless if there is missing data for a given year calc_monthly_stats(station_number = "08NM116", ignore_missing = TRUE) # Calculate statistics for water years starting in October calc_monthly_stats(station_number = "08NM116", start_year = 1980, water_year_start = 10) # Calculate statistics with custom years and percentiles calc_monthly_stats(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995), percentiles = c(25,75)) }
Performs a flow volume frequency analysis on annual statistics from a daily streamflow data set. Defaults to a low
flow frequency analysis using annual minimums. Set use_max = TRUE for annual high flow frequency analyses. Calculates
statistics from all values, unless specified. Function will calculate using all values in 'Values' column (no grouped analysis).
Analysis methodology replicates that from HEC-SSP. Returns a list of
tibbles and plots.
compute_annual_frequencies( data, dates = Date, values = Value, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", use_max = FALSE, use_log = FALSE, prob_plot_position = c("weibull", "median", "hazen"), prob_scale_points = c(0.9999, 0.999, 0.99, 0.9, 0.5, 0.2, 0.1, 0.02, 0.01, 0.001, 1e-04), fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), fit_quantiles = c(0.975, 0.99, 0.98, 0.95, 0.9, 0.8, 0.5, 0.2, 0.1, 0.05, 0.01), plot_curve = TRUE, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )compute_annual_frequencies( data, dates = Date, values = Value, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", use_max = FALSE, use_log = FALSE, prob_plot_position = c("weibull", "median", "hazen"), prob_scale_points = c(0.9999, 0.999, 0.99, 0.9, 0.5, 0.2, 0.1, 0.02, 0.01, 0.001, 1e-04), fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), fit_quantiles = c(0.975, 0.99, 0.98, 0.95, 0.9, 0.8, 0.5, 0.2, 0.1, 0.05, 0.01), plot_curve = TRUE, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
A data frame of daily data that contains columns of dates and flow values. Groupings and the |
dates |
Name of column in |
values |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
use_max |
Logical value to indicate using maximums rather than the minimums for analysis. Default |
use_log |
Logical value to indicate log-scale transforming of flow data before analysis. Default |
prob_plot_position |
Character string indicating the plotting positions used in the frequency plots, one of |
prob_scale_points |
Numeric vector of probabilities to be plotted along the X axis in the frequency plot. Inverse of
return period. Default |
fit_distr |
Character string identifying the distribution to fit annual data, one of |
fit_distr_method |
Character string identifying the method used to fit the distribution, one of |
fit_quantiles |
Numeric vector of quantiles to be estimated from the fitted distribution.
Default |
plot_curve |
Logical value to indicate plotting the computed curve on the probability plot. Default |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A list with the following elements:
Freq_Analysis_Data |
Data frame with computed annual summary statistics used in analysis. |
Freq_Plot_Data |
Data frame with co-ordinates used in frequency plot. |
Freq_Plot |
ggplot2 object with frequency plot. |
Freq_Fitting |
List of fitted objects from fitdistrplus. |
Freq_Fitted_Quantiles |
Data frame with fitted quantiles. |
## Not run: # Working examples (see arguments for further analysis options): # Compute an annual frequency analysis using default arguments results <- compute_annual_frequencies(station_number = "08NM116", start_year = 1980, end_year = 2010) # Compute an annual frequency analysis using default arguments (as listed) results <- compute_annual_frequencies(station_number = "08NM116", roll_days = c(1,3,7,30), start_year = 1980, end_year = 2010, prob_plot_position = "weibull", prob_scale_points = c(.9999, .999, .99, .9, .5, .2, .1, .02, .01, .001, .0001), fit_distr = "PIII", fit_distr_method = "MOM") # Compute a 7-day annual frequency analysis with "median" plotting positions # and fitting the data to a weibull distribution (not default PIII) results <- compute_annual_frequencies(station_number = "08NM116", roll_days = 7, start_year = 1980, end_year = 2010, prob_plot_position = "median", fit_distr = "weibull") ## End(Not run)## Not run: # Working examples (see arguments for further analysis options): # Compute an annual frequency analysis using default arguments results <- compute_annual_frequencies(station_number = "08NM116", start_year = 1980, end_year = 2010) # Compute an annual frequency analysis using default arguments (as listed) results <- compute_annual_frequencies(station_number = "08NM116", roll_days = c(1,3,7,30), start_year = 1980, end_year = 2010, prob_plot_position = "weibull", prob_scale_points = c(.9999, .999, .99, .9, .5, .2, .1, .02, .01, .001, .0001), fit_distr = "PIII", fit_distr_method = "MOM") # Compute a 7-day annual frequency analysis with "median" plotting positions # and fitting the data to a weibull distribution (not default PIII) results <- compute_annual_frequencies(station_number = "08NM116", roll_days = 7, start_year = 1980, end_year = 2010, prob_plot_position = "median", fit_distr = "weibull") ## End(Not run)
Calculates prewhitened nonlinear trends on annual streamflow data. Uses the
zyp package to calculate trends. Review zyp for more information
Calculates statistics from all values, unless specified. Returns a list of tibbles and plots.
All annual statistics calculated using the calc_all_annual_stats() function which uses the following
fasstr functions:
calc_annual_stats()
calc_annual_lowflows()
calc_annual_cumulative_stats()
calc_annual_flow_timing()
calc_monthly_stats()
calc_annual_normal_days()
compute_annual_trends( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, zyp_method, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, annual_percentiles = c(10, 90), monthly_percentiles = c(10, 20), stats_days = 1, stats_align = "right", lowflow_days = c(1, 3, 7, 30), lowflow_align = "right", timing_percent = c(25, 33, 50, 75), normal_percentiles = c(25, 75), complete_years = FALSE, ignore_missing = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0), include_plots = TRUE, zyp_alpha )compute_annual_trends( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, zyp_method, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, annual_percentiles = c(10, 90), monthly_percentiles = c(10, 20), stats_days = 1, stats_align = "right", lowflow_days = c(1, 3, 7, 30), lowflow_align = "right", timing_percent = c(25, 33, 50, 75), normal_percentiles = c(25, 75), complete_years = FALSE, ignore_missing = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0), include_plots = TRUE, zyp_alpha )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
zyp_method |
Character string identifying the prewhitened trend method to use from |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
annual_percentiles |
Numeric vector of percentiles to calculate annually. Set to |
monthly_percentiles |
Numeric vector of percentiles to calculate monthly for each year. Set to |
stats_days |
Numeric vector of the number of days to apply a rolling mean on basic stats. Default |
stats_align |
Character string identifying the direction of the rolling mean on basic stats from the specified date, either by
the first ( |
lowflow_days |
Numeric vector of the number of days to apply a rolling mean on low flow stats. Default |
lowflow_align |
Character string identifying the direction of the rolling mean on low flow stats from the specified date,
either by the first ( |
timing_percent |
Numeric vector of percents of annual total flows to determine dates. Used for |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing_annual |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate an annual statistic (0 to 100 percent). If |
allowed_missing_monthly |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a monthly statistic (0 to 100 percent). If |
include_plots |
Logical value indicating if annual trending plots should be included. Default |
zyp_alpha |
Numeric value of the significance level (ex. |
A list of tibbles and optional plots from the trending analysis including:
Annual_Trends_Data |
a tibble of the annual statistics used for trending |
Annual_Trends_Results |
a tibble of the results of the zyp trending analysis |
Annual_* |
each ggplot2 object for each annual trended statistic |
References:
Büger, G. 2017. On trend detection. Hydrological Processes 31, 4039–4042. https://doi.org/10.1002/hyp.11280.
Sen, P.K., 1968. Estimates of the Regression Coefficient Based on Kendall's Tau. Journal of the American Statistical Association Vol. 63, No. 324: 1379-1389.
Wang, X.L. and Swail, V.R., 2001. Changes in extreme wave heights in northern hemisphere oceans and related atmospheric circulation regimes. Journal of Climate, 14: 2204-2221.
Yue, S., P. Pilon, B. Phinney and G. Cavadias, 2002. The influence of autocorrelation on the ability to detect trend in hydrological series. Hydrological Processes, 16: 1807-1829.
Zhang, X., Vincent, L.A., Hogg, W.D. and Niitsoo, A., 2000. Temperature and Precipitation Trends in Canada during the 20th Century. Atmosphere-Ocean 38(3): 395-429.
Zhang, X., Zwiers, F.W., 2004. Comment on “Applicability of prewhitening to eliminate the influence of serial correlation on the Mann-Kendall test” by Sheng Yue and Chun Yuan Wang. Water Resources Research 40. https://doi.org/10.1029/2003WR002073.
zyp-package,
calc_all_annual_stats
## Not run: # Working examples: # Compute trends statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") trends <- compute_annual_trends(data = flow_data, zyp_method = "zhang") # Compute trends statistics using station_number with defaults trends <- compute_annual_trends(station_number = "08NM116", zyp_method = "zhang") # Compute trends statistics and plot a trend line if the significance is less than 0.05 trends <- compute_annual_trends(station_number = "08NM116", zyp_method = "zhang", zyp_alpha = 0.05) # Compute trends statistics and do not plot the results trends <- compute_annual_trends(station_number = "08NM116", zyp_method = "zhang", include_plots = FALSE) ## End(Not run)## Not run: # Working examples: # Compute trends statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") trends <- compute_annual_trends(data = flow_data, zyp_method = "zhang") # Compute trends statistics using station_number with defaults trends <- compute_annual_trends(station_number = "08NM116", zyp_method = "zhang") # Compute trends statistics and plot a trend line if the significance is less than 0.05 trends <- compute_annual_trends(station_number = "08NM116", zyp_method = "zhang", zyp_alpha = 0.05) # Compute trends statistics and do not plot the results trends <- compute_annual_trends(station_number = "08NM116", zyp_method = "zhang", include_plots = FALSE) ## End(Not run)
Performs a volume frequency analysis on custom data. Defaults to ranking by minimums; use use_max for to
rank by maximum flows. Calculates the statistics from events and flow values provided. Columns of events (e.g. years), their
values (minimums or maximums), and identifiers (low-flows, high-flows, etc.). Function will calculate using all values in the
provided data (no grouped analysis). Analysis methodology replicates that from
HEC-SSP. Returns a list of tibbles and plots.
compute_frequency_analysis( data, events = Year, values = Value, measures = Measure, use_max = FALSE, use_log = FALSE, prob_plot_position = c("weibull", "median", "hazen"), prob_scale_points = c(0.9999, 0.999, 0.99, 0.9, 0.5, 0.2, 0.1, 0.02, 0.01, 0.001, 1e-04), compute_fitting = TRUE, fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), fit_quantiles = c(0.975, 0.99, 0.98, 0.95, 0.9, 0.8, 0.5, 0.2, 0.1, 0.05, 0.01), plot_curve = TRUE, plot_axis_title = "Discharge (cms)" )compute_frequency_analysis( data, events = Year, values = Value, measures = Measure, use_max = FALSE, use_log = FALSE, prob_plot_position = c("weibull", "median", "hazen"), prob_scale_points = c(0.9999, 0.999, 0.99, 0.9, 0.5, 0.2, 0.1, 0.02, 0.01, 0.001, 1e-04), compute_fitting = TRUE, fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), fit_quantiles = c(0.975, 0.99, 0.98, 0.95, 0.9, 0.8, 0.5, 0.2, 0.1, 0.05, 0.01), plot_curve = TRUE, plot_axis_title = "Discharge (cms)" )
data |
A data frame of data that contains columns of events, flow values, and measures (data type). |
events |
Column in |
values |
Column in |
measures |
Column in |
use_max |
Logical value to indicate using maximums rather than the minimums for analysis. Default |
use_log |
Logical value to indicate log-scale transforming of flow data before analysis. Default |
prob_plot_position |
Character string indicating the plotting positions used in the frequency plots, one of |
prob_scale_points |
Numeric vector of probabilities to be plotted along the X axis in the frequency plot. Inverse of
return period. Default |
compute_fitting |
Logical value to indicate whether to fit plotting positions to a distribution. If 'FALSE' the output will
return only the data, plotting positions, and plot. Default |
fit_distr |
Character string identifying the distribution to fit annual data, one of |
fit_distr_method |
Character string identifying the method used to fit the distribution, one of |
fit_quantiles |
Numeric vector of quantiles to be estimated from the fitted distribution.
Default |
plot_curve |
Logical value to indicate plotting the computed curve on the probability plot. Default |
plot_axis_title |
Character string of the plot y-axis title. Default |
A list with the following elements:
Freq_Analysis_Data |
Data frame with provided data for analysis. |
Freq_Plot_Data |
Data frame with plotting positions used in frequency plot. |
Freq_Plot |
ggplot2 object with plotting positions and (optional) fitted curve. |
Freq_Fitting |
List of fitted objects from fitdistrplus. |
Freq_Fitted_Quantiles |
Data frame with fitted quantiles. |
## Not run: # Working example: # Calculate some values to use for a frequency analysis # (requires years, values for those years, and the name of the measure/metric) low_flows <- calc_annual_lowflows(station_number = "08NM116", start_year = 1980, end_year = 2000, roll_days = 7) low_flows <- dplyr::select(low_flows, Year, Value = Min_7_Day) low_flows <- dplyr::mutate(low_flows, Measure = "7-Day") # Compute the frequency analysis using the default parameters results <- compute_frequency_analysis(data = low_flows, events = Year, values = Value, measure = Measure) ## End(Not run)## Not run: # Working example: # Calculate some values to use for a frequency analysis # (requires years, values for those years, and the name of the measure/metric) low_flows <- calc_annual_lowflows(station_number = "08NM116", start_year = 1980, end_year = 2000, roll_days = 7) low_flows <- dplyr::select(low_flows, Year, Value = Min_7_Day) low_flows <- dplyr::mutate(low_flows, Measure = "7-Day") # Compute the frequency analysis using the default parameters results <- compute_frequency_analysis(data = low_flows, events = Year, values = Value, measure = Measure) ## End(Not run)
Performs a volume frequency analysis on annual statistics from a daily streamflow data set and calculates a statistic
based on the provided mean n-days and return period of the statistic, defaults to minimum flows. For example, to determine the
7Q10 of a data set, set the roll_days to 7 and the return_period to 10. Function will calculate using
all values in 'Values' column (no grouped analysis), unless specified. Analysis methodology replicates that from
HEC-SSP. Returns a tibble with statistics.
compute_frequency_quantile( data, dates = Date, values = Value, station_number, roll_days = NA, roll_align = "right", return_period = NA, use_max = FALSE, use_log = FALSE, fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )compute_frequency_quantile( data, dates = Date, values = Value, station_number, roll_days = NA, roll_align = "right", return_period = NA, use_max = FALSE, use_log = FALSE, fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
A data frame of data that contains columns of events, flow values, and measures (data type). |
dates |
Name of column in |
values |
Column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Required. |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
return_period |
Numeric vector of the estimated time interval, in years, between flow events of a similar size, inverse of probability, used to estimate the frequency statistic. Required. |
use_max |
Logical value to indicate using maximums rather than the minimums for analysis. Default |
use_log |
Logical value to indicate log-scale transforming of flow data before analysis. Default |
fit_distr |
Character string identifying the distribution to fit annual data, one of |
fit_distr_method |
Character string identifying the method used to fit the distribution, one of |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A numeric value of the frequency analysis quantile, given the roll_days and return_period.
## Not run: # Working example: # Compute the annual 7-day flow value with a 1 in 10 year return interval compute_frequency_quantile(station_number = "08NM116", roll_days = 7, return_period = 10) ## End(Not run)## Not run: # Working example: # Compute the annual 7-day flow value with a 1 in 10 year return interval compute_frequency_quantile(station_number = "08NM116", roll_days = 7, return_period = 10) ## End(Not run)
Calculates tables and plots from a suite of statistics from fasstr functions. Calculates statistics from all
values, unless specified.The statistics are grouped into 7 analysis groups (see analyses argument) which are stored in
lists in the object. Due to the number of tables and plots to be made, this function may take several minutes to complete. If
ignore_missing = FALSE (default) and there is missing data, some tables and plots may be empty and produce warnings.
Use ignore_missing = TRUE to ignore the missing values or filter your data to complete years.
Returns a list of tibbles and plots.
compute_full_analysis( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, analyses = 1:7, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0), zyp_method = "zhang", zyp_alpha )compute_full_analysis( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, analyses = 1:7, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0), zyp_method = "zhang", zyp_alpha )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
analyses |
Numeric vector of analyses to run (default is all (
|
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing_annual |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate an annual statistic (0 to 100 percent). If |
allowed_missing_monthly |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a monthly statistic (0 to 100 percent). If |
zyp_method |
Character string identifying the prewhitened trend method to use from |
zyp_alpha |
Numeric value of the significance level (ex. |
A list of lists of tibble data frames and ggplot2 objects from various fasstr functions organized by the analysis groups as listed above.
plot_flow_data,
screen_flow_data,
plot_data_screening,
plot_missing_dates,
calc_longterm_monthly_stats,
plot_longterm_monthly_stats,
calc_longterm_daily_stats,
plot_longterm_daily_stats,
plot_monthly_means,
plot_flow_duration,
calc_annual_stats,
plot_annual_stats,
calc_annual_cumulative_stats,
plot_annual_cumulative_stats,
calc_annual_flow_timing,
plot_annual_flow_timing,
calc_annual_normal_days,
plot_annual_normal_days,
calc_annual_lowflows,
plot_annual_lowflows,
plot_annual_means,
calc_monthly_stats,
plot_monthly_stats,
calc_monthly_cumulative_stats,
plot_monthly_cumulative_stats,
calc_daily_stats,
plot_daily_stats,
calc_daily_cumulative_stats,
plot_daily_cumulative_stats,
compute_annual_trends,
compute_annual_frequencies,
write_flow_data,
write_plots
## Not run: # Working examples: # Compute a full analysis will all the analyses results <- compute_full_analysis(station_number = "08NM116", start_year = 1980, end_year = 2010) # Compute a full analysis with only Annual (3) and Daily (5) analyses results <- compute_full_analysis(station_number = "08NM116", start_year = 1980, end_year = 2010, analyses = c(3,5)) ## End(Not run)## Not run: # Working examples: # Compute a full analysis will all the analyses results <- compute_full_analysis(station_number = "08NM116", start_year = 1980, end_year = 2010) # Compute a full analysis with only Annual (3) and Daily (5) analyses results <- compute_full_analysis(station_number = "08NM116", start_year = 1980, end_year = 2010, analyses = c(3,5)) ## End(Not run)
Performs a volume frequency analysis on annual peak statistics (instantaneous minimums or maximums) extracted from
HYDAT. Calculates statistics from all years, unless specified. The data argument is not available. Analysis
methodology replicates that from HEC-SSP. Returns a list of tibbles
and plots.
compute_hydat_peak_frequencies( station_number, use_max = FALSE, use_log = FALSE, prob_plot_position = c("weibull", "median", "hazen"), prob_scale_points = c(0.9999, 0.999, 0.99, 0.9, 0.5, 0.2, 0.1, 0.02, 0.01, 0.001, 1e-04), fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), fit_quantiles = c(0.975, 0.99, 0.98, 0.95, 0.9, 0.8, 0.5, 0.2, 0.1, 0.05, 0.01), start_year, end_year, exclude_years, plot_curve = TRUE )compute_hydat_peak_frequencies( station_number, use_max = FALSE, use_log = FALSE, prob_plot_position = c("weibull", "median", "hazen"), prob_scale_points = c(0.9999, 0.999, 0.99, 0.9, 0.5, 0.2, 0.1, 0.02, 0.01, 0.001, 1e-04), fit_distr = c("PIII", "weibull"), fit_distr_method = ifelse(fit_distr == "PIII", "MOM", "MLE"), fit_quantiles = c(0.975, 0.99, 0.98, 0.95, 0.9, 0.8, 0.5, 0.2, 0.1, 0.05, 0.01), start_year, end_year, exclude_years, plot_curve = TRUE )
station_number |
A character string vector of seven digit Water Survey of Canada station numbers (e.g. |
use_max |
Logical value to indicate using maximums rather than the minimums for analysis. Default |
use_log |
Logical value to indicate log-scale transforming of flow data before analysis. Default |
prob_plot_position |
Character string indicating the plotting positions used in the frequency plots, one of |
prob_scale_points |
Numeric vector of probabilities to be plotted along the X axis in the frequency plot. Inverse of
return period. Default |
fit_distr |
Character string identifying the distribution to fit annual data, one of |
fit_distr_method |
Character string identifying the method used to fit the distribution, one of |
fit_quantiles |
Numeric vector of quantiles to be estimated from the fitted distribution.
Default |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
plot_curve |
Logical value to indicate plotting the computed curve on the probability plot. Default |
A list with the following elements:
Freq_Analysis_Data |
Data frame with computed annual summary statistics used in analysis. |
Freq_Plot_Data |
Data frame with co-ordinates used in frequency plot. |
Freq_Plot |
ggplot2 object with frequency plot |
Freq_Fitting |
List of fitted objects from fitdistrplus. |
Freq_Fitted_Quantiles |
Data frame with fitted quantiles. |
## Not run: # Working examples (see arguments for further analysis options): # Compute an annual peak frequency analysis using default arguments (instantaneous lows) results <- compute_hydat_peak_frequencies(station_number = "08NM116", start_year = 1980, end_year = 2010) # Compute an annual peak frequency analysis using default arguments (instantaneous highs) results <- compute_hydat_peak_frequencies(station_number = "08NM116", start_year = 1980, end_year = 2010, use_max = TRUE) ## End(Not run)## Not run: # Working examples (see arguments for further analysis options): # Compute an annual peak frequency analysis using default arguments (instantaneous lows) results <- compute_hydat_peak_frequencies(station_number = "08NM116", start_year = 1980, end_year = 2010) # Compute an annual peak frequency analysis using default arguments (instantaneous highs) results <- compute_hydat_peak_frequencies(station_number = "08NM116", start_year = 1980, end_year = 2010, use_max = TRUE) ## End(Not run)
Fills data gaps of missing dates of the data provided. Builds a continuous data set from the start date to the end date.
Only missing dates are filled, columns not specified as dates or groups will be filled with NA. Will completely fill first and
last years, unless specified using pad_ends = FALSE.
fill_missing_dates( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, water_year_start = 1, pad_ends = TRUE )fill_missing_dates( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, water_year_start = 1, pad_ends = TRUE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
water_year_start |
Numeric value indicating the month ( |
pad_ends |
Logical value indicating whether to fill incomplete start and end years with rows of dates.
If |
A tibble data frame of the source data with additional rows where missing dates existed.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Fill missing dates with NA using calendar years fill_missing_dates(station_number = "08NM116") # Fill missing dates with NA using water years starting in August fill_missing_dates(station_number = "08NM116", water_year_start = 8) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Fill missing dates with NA using calendar years fill_missing_dates(station_number = "08NM116") # Fill missing dates with NA using water years starting in August fill_missing_dates(station_number = "08NM116", water_year_start = 8) }
Plots annual and seasonal (if include_seaons = TRUE) total flows, volumetric discharge or water yields, from a
daily streamflow data set. Calculates statistics from all values, unless specified. Data calculated from
plot_annual_cumulative_stats() function. For water year and seasonal data, the designated year is the year in which the
year or season ends. Returns a list of plots.
plot_annual_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_seasons = FALSE, include_title = FALSE, complete_years = FALSE, plot_type = "bar" )plot_annual_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_seasons = FALSE, include_title = FALSE, complete_years = FALSE, plot_type = "bar" )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
use_yield |
Logical value indicating whether to calculate area-based water yield, in mm, instead of volumetric discharge.
Default |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
include_seasons |
Logical value indication whether to include seasonal yields or volumetric discharges. Default |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
plot_type |
Type of plot, either |
A list of ggplot2 objects with the following for each station provided:
Annual_Total_Volume |
annual total volumetric discharge, in cubic metres |
Two_Seasons_Total_Volume |
if include_seasons = TRUE, two seasons total volumetric discharges, in cubic metres |
Four_Seasons_Total_Volume |
if include_seasons = TRUE, four seasons total volumetric discharges, in cubic metres |
If use_yield argument is used the list will contain the following objects:
Annual_Yield |
annual water yield, in millimetres |
Two_Seasons_Yield |
if include_seasons = TRUE, two seasons water yield, in millimetres |
Four_Seasons_Yield |
if include_seasons = TRUE, four seasons water yield, in millimetres |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual cumulative yield statistics with default HYDAT basin area plot_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Plot annual cumulative yield statistics with custom basin area plot_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual cumulative yield statistics with default HYDAT basin area plot_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Plot annual cumulative yield statistics with custom basin area plot_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }
Plots annual n-day minimum and maximum values and the day of year of occurrence of daily flow values from a daily streamflow data set. Calculates statistics from all values, unless specified. Returns a tibble with statistics.
plot_annual_extremes( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_days_min = NA, roll_days_max = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_min = NA, months_max = NA, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE )plot_annual_extremes( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_days_min = NA, roll_days_max = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_min = NA, months_max = NA, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_days_min |
Numeric value of the number of days to apply a rolling mean for low flows. Will override 'roll_days' argument
for low flows. Default |
roll_days_max |
Numeric value of the number of days to apply a rolling mean for high flows. Will override 'roll_days' argument
for high flows. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
months_min |
Numeric vector of specified months for window of low flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for low flows. Default |
months_max |
Numeric vector of specified months for window of high flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for high flows. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Extreme_Flows |
ggplot2 object of annual minimum and maximum flows of selected n-day rolling means |
Annual_Extreme_Flows_Dates |
ggplot2 object of the day of years of annual minimum and maximum flows of selected n-day rolling means |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual 1-day (default) max/min flow data with # default alignment ('right') plot_annual_extremes(station_number = "08NM116") # Plot custom annual 3-day max and 7-min flow data with 'center' alignment plot_annual_extremes(station_number = "08NM116", roll_days_max = 3, roll_days_min = 7, roll_align = "center") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual 1-day (default) max/min flow data with # default alignment ('right') plot_annual_extremes(station_number = "08NM116") # Plot custom annual 3-day max and 7-min flow data with 'center' alignment plot_annual_extremes(station_number = "08NM116", roll_days_max = 3, roll_days_min = 7, roll_align = "center") }
Plots an annual hydrograph for a specific year with the values and timing of annual n-day low and high flows.
The 'normal' range of percentiles also plotted for reference and are calculated from only years of complete data.
Shows the values and dates of max/mins for a specific year from the calc_annual_extremes() and
plot_annual_extremes() functions. Can remove either low or high flows using plot_min = FALSE() or
plot_max = FALSE(), respectively. Returns a list of plots.
plot_annual_extremes_year( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, year_to_plot = NA, roll_days = 1, roll_days_min = NA, roll_days_max = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_min = NA, months_max = NA, log_discharge = TRUE, log_ticks = FALSE, include_title = FALSE, plot_normal_percentiles = TRUE, normal_percentiles = c(25, 75), plot_min = TRUE, plot_max = TRUE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )plot_annual_extremes_year( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, year_to_plot = NA, roll_days = 1, roll_days_min = NA, roll_days_max = NA, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, months_min = NA, months_max = NA, log_discharge = TRUE, log_ticks = FALSE, include_title = FALSE, plot_normal_percentiles = TRUE, normal_percentiles = c(25, 75), plot_min = TRUE, plot_max = TRUE, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
year_to_plot |
Numeric value indicating the year/water year to plot flow data with normal category colours. Default |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_days_min |
Numeric value of the number of days to apply a rolling mean for low flows. Will override 'roll_days' argument
for low flows. Default |
roll_days_max |
Numeric value of the number of days to apply a rolling mean for high flows. Will override 'roll_days' argument
for high flows. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of specific months to plot. For example, |
months_min |
Numeric vector of specified months for window of low flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for low flows. Default |
months_max |
Numeric vector of specified months for window of high flows (3 for March, 6:8 for Jun-Aug). Will override 'months'
argument for high flows. Default |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
plot_normal_percentiles |
Logical value indicating whether to plot the normal percentiles ribbon. Default |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
plot_min |
Logical value indicating whether to plot annual low flows. Default |
plot_max |
Logical value indicating whether to plot annual high flows. Default |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
A list of ggplot2 objects with the following for each station provided:
Annual_Extremes_Year |
a plot that contains the an annual hydrograph and identified low and high flow periods |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot the year 2000 with the annual maximum and minimums plot_annual_extremes_year(station_number = "08NM116", roll_days_max = 3, roll_days_min = 7, year_to_plot = 2001) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot the year 2000 with the annual maximum and minimums plot_annual_extremes_year(station_number = "08NM116", roll_days_max = 3, roll_days_min = 7, year_to_plot = 2001) }
Plots the timing (day of year and date) of portions of total annual flow of daily flow
values from a daily streamflow data set. Calculates statistics from all values from complete years, unless specified.
Data calculated using calc_annual_flow_timing() function. Returns a list of plots.
plot_annual_flow_timing( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percent_total = c(25, 33.3, 50, 75), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_title = FALSE )plot_annual_flow_timing( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percent_total = c(25, 33.3, 50, 75), water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percent_total |
Numeric vector of percents of total annual flows to determine dates. Default |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Flow_Timing |
a plot that contains each n-percent of total volumetric discharge |
Default plots on each object:
DoY_25pct_TotalQ |
day of year of 25-percent of total volumetric discharge |
DoY_33.3pct_TotalQ |
day of year of 33.3-percent of total volumetric discharge |
DoY_50pct_TotalQ |
day of year of 50-percent of total volumetric discharge |
DoY_75pct_TotalQ |
day of year of 75-percent of total volumetric discharge |
Barnett, T.P., Pierce, D.W., Hidalgo, H.G., Bonfils, C., Santer, B.D., Das, T., Bala, G., Wood, A.W., Nozawa, T., Mirin, A.A., Cayan, D.R., Dettinger, M.D., 2008. Human-Induced Clanges in the Hydrology of the Western United States. Science 319, 1080-1083.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual flow timing statistics with default percent totals plot_annual_flow_timing(station_number = "08NM116") # Plot annual flow timing with custom percent totals plot_annual_flow_timing(station_number = "08NM116", percent_total = 50, start_year = 1980) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual flow timing statistics with default percent totals plot_annual_flow_timing(station_number = "08NM116") # Plot annual flow timing with custom percent totals plot_annual_flow_timing(station_number = "08NM116", percent_total = 50, start_year = 1980) }
Plots an annual hydrograph for a specific year with the dates of flow timing of portions of total annual flow identified.
The 'normal' range of percentiles also plotted for reference and are calculated from only years of complete data.
Shows the dates of flow timing for a specific year from the counts from the plot_annual_flow_timing() function.
Returns a list of plots.
plot_annual_flow_timing_year( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percent_total = c(25, 33.3, 50, 75), year_to_plot = NA, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = TRUE, log_ticks = FALSE, include_title = FALSE, plot_vlines = TRUE, plot_normal_percentiles = TRUE, normal_percentiles = c(25, 75) )plot_annual_flow_timing_year( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percent_total = c(25, 33.3, 50, 75), year_to_plot = NA, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = TRUE, log_ticks = FALSE, include_title = FALSE, plot_vlines = TRUE, plot_normal_percentiles = TRUE, normal_percentiles = c(25, 75) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percent_total |
Numeric vector of percents of total annual flows to determine dates. Default |
year_to_plot |
Numeric value indicating the year/water year to plot flow data with normal category colours. Default |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
plot_vlines |
Logical value indicating whether to plot the vertical lines indicating dates of flow timing. Default |
plot_normal_percentiles |
Logical value indicating whether to plot the normal percentiles ribbon. Default |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Normal_Days_Year |
a plot that contains the above, below, and normal colour daily flow points |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot the year 2000 and change the flow timing percent totals plot_annual_flow_timing_year(station_number = "08NM116", percent_total = 50, year_to_plot = 2000) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot the year 2000 and change the flow timing percent totals plot_annual_flow_timing_year(station_number = "08NM116", percent_total = 50, year_to_plot = 2000) }
Plot annual n-day maximum values, and the day of year and date of occurrence of daily flow values from a daily
streamflow data set. Calculates statistics from all values, unless specified. Data calculated from calc_annual_highflows()
function. Returns a list of plots.
plot_annual_highflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE )plot_annual_highflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Maximums |
ggplot2 object of annual maximums of selected n-day rolling means |
Annual_Maximums_Days |
ggplot2 object of the day of years of annual maximums of selected n-day rolling means |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual 1, 3, 7, and 30-day (default) high flow statistics with default alignment plot_annual_highflows(station_number = "08NM116") # Plot annual custom 3 and 7-day high flow statistics with "center" alignment plot_annual_highflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual 1, 3, 7, and 30-day (default) high flow statistics with default alignment plot_annual_highflows(station_number = "08NM116") # Plot annual custom 3 and 7-day high flow statistics with "center" alignment plot_annual_highflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center") }
Plot annual n-day minimum values, and the day of year and date of occurrence of daily flow values from a daily
streamflow data set. Calculates statistics from all values, unless specified. Data calculated from calc_annual_lowflows()
function. Returns a list of plots.
plot_annual_lowflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE )plot_annual_lowflows( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = c(1, 3, 7, 30), roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Minimums |
ggplot2 object of annual minimums of selected n-day rolling means |
Annual_Minimums_Days |
ggplot2 object of the day of years of annual minimums of selected n-day rolling means |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual 1, 3, 7, and 30-day (default) low flow statistics with default alignment plot_annual_lowflows(station_number = "08NM116") # Plot annual custom 3 and 7-day low flow statistics with "center" alignment plot_annual_lowflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual 1, 3, 7, and 30-day (default) low flow statistics with default alignment plot_annual_lowflows(station_number = "08NM116") # Plot annual custom 3 and 7-day low flow statistics with "center" alignment plot_annual_lowflows(station_number = "08NM116", roll_days = c(3,7), roll_align = "center") }
Plot annual means using the long-term annual mean as the point of reference for annual means. Calculates statistics
from all values, unless specified. Data calculated using calc_annual_stats() function. Returns a list of plots.
plot_annual_means( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE, percentiles_mad = c(10, 90) )plot_annual_means( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), include_title = FALSE, percentiles_mad = c(10, 90) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
percentiles_mad |
Numeric vector of percentiles of annual means to plot, up to two values. Set to |
A list of ggplot2 objects for with the following plots for each station provided:
Annual_Means |
a plot that contains annual means with the long-term mean as the x-axis intercept |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual means plot_annual_means(station_number = "08NM116") # Plot mean flows from July-September plot_annual_means(station_number = "08NM116", months = 7:9) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual means plot_annual_means(station_number = "08NM116") # Plot mean flows from July-September plot_annual_means(station_number = "08NM116", months = 7:9) }
Plots the number of days per year within, above and below the 'normal' range (typically between 25 and 75th percentiles) for
each day of the year. Upper and lower-range percentiles are calculated for each day of the year of from all years, and then each
daily flow value for each year is compared. Calculates statistics from all
values from complete years, unless specified. Data calculated using calc_annual_normal_days()
function. Returns a list of plots.
plot_annual_normal_days( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_title = FALSE )plot_annual_normal_days( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Normal_Days |
a plot that contains the number of days outside normal |
Default plots on each object:
Normal_Days |
number of days per year below and above the daily normal (default 25/75th percentile) |
Below_Normal_Days |
number of days per year below the daily normal (default 25th percentile) |
Above_Normal_Days |
number of days per year above the daily normal (default 75th percentile) |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics with default limits of normal (25 and 75th percentiles) plot_annual_normal_days(station_number = "08NM116") # Plot annual statistics with custom limits of normal plot_annual_normal_days(station_number = "08NM116", normal_percentiles = c(10,90)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics with default limits of normal (25 and 75th percentiles) plot_annual_normal_days(station_number = "08NM116") # Plot annual statistics with custom limits of normal plot_annual_normal_days(station_number = "08NM116", normal_percentiles = c(10,90)) }
Plots an annual hydrograph for a specific year with daily flow values coloured by whether the daily values are normal,
above normal, or below normal, overlaying the normals range. The normal range is typically between 25 and 75th percentiles for
each day of the year. Upper and lower-range percentiles are calculated for each day of the year of from all years, and then each
daily flow value for each year is compared. Normals calculated from only years of complete data, although incomplete years can be
plotted. Shows the annual values for a specific year from the counts from the plot_annual_normal_days() function.
Returns a list of plots.
plot_annual_normal_days_year( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), year_to_plot = NA, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = TRUE, log_ticks = FALSE, include_title = FALSE, plot_flow_line = TRUE, plot_normal_percentiles = TRUE )plot_annual_normal_days_year( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), year_to_plot = NA, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = TRUE, log_ticks = FALSE, include_title = FALSE, plot_flow_line = TRUE, plot_normal_percentiles = TRUE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
year_to_plot |
Numeric value indicating the year/water year to plot flow data with normal category colours. Default |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
plot_flow_line |
Logical value indicating whether to connect flow data coloured points with lines. Default |
plot_normal_percentiles |
Logical value indicating whether to plot the normal percentiles ribbon. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Normal_Days_Year |
a plot that contains the above, below, and normal colour daily flow points |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot the year 2000 using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_normal_days_year(data = flow_data, year_to_plot = 2000) # Plot the year 2000 using the station_number argument plot_annual_normal_days_year(station_number = "08NM116", year_to_plot = 2000) # Plot the year 2000 and change the normal percentiles range plot_annual_normal_days_year(station_number = "08NM116", normal_percentiles = c(20,80), year_to_plot = 2000) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot the year 2000 using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_normal_days_year(data = flow_data, year_to_plot = 2000) # Plot the year 2000 using the station_number argument plot_annual_normal_days_year(station_number = "08NM116", year_to_plot = 2000) # Plot the year 2000 and change the normal percentiles range plot_annual_normal_days_year(station_number = "08NM116", normal_percentiles = c(20,80), year_to_plot = 2000) }
This function has been superseded by the plot_annual_normal_days() function.
Plots the number of days per year outside of the 'normal' range (typically between 25 and 75th percentiles) for
each day of the year. Upper and lower-range percentiles are calculated for each day of the year of from all years, and then each
daily flow value for each year is compared. All days above or below the normal range are included. Calculates statistics from all
values from complete years, unless specified. Data calculated using calc_annual_outside_normal()
function. Returns a list of plots.
plot_annual_outside_normal( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_title = FALSE )plot_annual_outside_normal( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, normal_percentiles = c(25, 75), roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
normal_percentiles |
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. Default |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Annual_Days_Outside_Normal |
a plot that contains the number of days outside normal |
Default plots on each object:
Days_Below_Normal |
number of days per year below the daily normal (default 25th percentile) |
Days_Above_Normal |
number of days per year above the daily normal (default 75th percentile) |
Days_Outside_Normal |
number of days per year below and above the daily normal (default 25/75th percentile) |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics with default limits of normal (25 and 75th percentiles) plot_annual_outside_normal(station_number = "08NM116") # Plot annual statistics with custom limits of normal plot_annual_outside_normal(station_number = "08NM116", normal_percentiles = c(10,90)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics with default limits of normal (25 and 75th percentiles) plot_annual_outside_normal(station_number = "08NM116") # Plot annual statistics with custom limits of normal plot_annual_outside_normal(station_number = "08NM116", normal_percentiles = c(10,90)) }
Plots means, medians, maximums, minimums, and percentiles for each year from all years of a daily streamflow
data set. Calculates statistics from all values, unless specified. Data calculated using calc_annual_stats() function.
Returns a list of plots.
plot_annual_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )plot_annual_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects for with the following plots (percentile plots optional) for each station provided:
Annual_Stats |
a plot that contains annual statistics |
Default plots on each object:
Mean |
annual mean of all daily flows |
Median |
annual median of all daily flows |
Maximum |
annual maximum of all daily flows |
Minimum |
annual minimum of all daily flows |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_stats(data = flow_data) # Plot annual statistics using station_number argument with defaults plot_annual_stats(station_number = "08NM116") # Plot annual statistics regardless if there is missing data for a given year plot_annual_stats(station_number = "08NM116", ignore_missing = TRUE) # Plot annual statistics for water years starting in October plot_annual_stats(station_number = "08NM116", water_year_start = 10) # Plot annual statistics with custom years and percentiles plot_annual_stats(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995), percentiles = c(25,75)) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_stats(data = flow_data) # Plot annual statistics using station_number argument with defaults plot_annual_stats(station_number = "08NM116") # Plot annual statistics regardless if there is missing data for a given year plot_annual_stats(station_number = "08NM116", ignore_missing = TRUE) # Plot annual statistics for water years starting in October plot_annual_stats(station_number = "08NM116", water_year_start = 10) # Plot annual statistics with custom years and percentiles plot_annual_stats(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995), percentiles = c(25,75)) }
Plots means, medians, maximums, minimums, and percentiles as ribbons for each year from all years of a daily streamflow
data set. Calculates statistics from all values, unless specified. Data calculated using calc_annual_stats() function.
Returns a list of plots.
plot_annual_stats2( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )plot_annual_stats2( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
plot_extremes |
Logical value to indicate plotting a ribbon with the range of daily minimum and maximum flows.
Default |
plot_inner_percentiles |
Logical value indicating whether to plot the inner percentiles ribbon. Default |
plot_outer_percentiles |
Logical value indicating whether to plot the outer percentiles ribbon. Default |
inner_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
inner percentiles ribbon for plotting. Default |
outer_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
outer percentiles ribbon for plotting. Default |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects for with the following plots (percentile plots optional) for each station provided:
Annual_Stats |
a plot that contains annual statistics |
Default plots on each object:
Mean |
annual mean |
Median |
annual median |
25-75 Percentiles |
a ribbon showing the range of data between the annual 25th and 75th percentiles |
5-95 Percentiles |
a ribbon showing the range of data between the annual 5th and 95th percentiles |
Minimum-Maximum |
a ribbon showing the range of data between the annual minimum and maximums |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_stats2(data = flow_data) # Plot annual statistics using station_number argument with defaults plot_annual_stats2(station_number = "08NM116") # Plot annual statistics regardless if there is missing data for a given year plot_annual_stats2(station_number = "08NM116", ignore_missing = TRUE) # Plot annual statistics for water years starting in October plot_annual_stats2(station_number = "08NM116", water_year_start = 10) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_stats2(data = flow_data) # Plot annual statistics using station_number argument with defaults plot_annual_stats2(station_number = "08NM116") # Plot annual statistics regardless if there is missing data for a given year plot_annual_stats2(station_number = "08NM116", ignore_missing = TRUE) # Plot annual statistics for water years starting in October plot_annual_stats2(station_number = "08NM116", water_year_start = 10) }
Plots data symbols for a daily data set by year, either by day of year, total days, or percent of year (see
plot_type argument. A column of symbols is required, default symbols = 'Symbol'. For HYDAT data, symbols
include: 'E' Estimate, 'A' Partial Day, 'B' Ice Conditions, 'D' Dry, and 'R' Revised. Other symbols or categories may be
used to colour points of plot. Returns a list of plots.
plot_annual_symbols( data, dates = Date, values = Value, groups = STATION_NUMBER, symbols = Symbol, station_number, water_year_start = 1, start_year, end_year, months = 1:12, include_title = FALSE, plot_type = "dayofyear" )plot_annual_symbols( data, dates = Date, values = Value, groups = STATION_NUMBER, symbols = Symbol, station_number, water_year_start = 1, start_year, end_year, months = 1:12, include_title = FALSE, plot_type = "dayofyear" )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
symbols |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
months |
Numeric vector of months to include in plotting For example, |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
plot_type |
Character. One of |
A list of ggplot2 objects with the following for each station provided:
Annual_Symbols |
a plot that contains data symbols and missing dates |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual symbol counts from a data frame and data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_symbols(data = flow_data) # Plot annual symbol counts using station_number argument with defaults plot_annual_symbols(station_number = "08NM116") # Plot annual symbol percentages using station_number argument and plot by annual counts plot_annual_symbols(station_number = "08NM116", plot_type = "count") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual symbol counts from a data frame and data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_annual_symbols(data = flow_data) # Plot annual symbol counts using station_number argument with defaults plot_annual_symbols(station_number = "08NM116") # Plot annual symbol percentages using station_number argument and plot by annual counts plot_annual_symbols(station_number = "08NM116", plot_type = "count") }
Plot the daily cumulative mean, median, maximum, minimum, and 5, 25, 75, 95th percentiles for each day of the year
from a daily streamflow data set. Calculates statistics from all values from complete, unless specified.
Data calculated using calc_daily_cumulative_stats() function. Can plot individual years for comparison using the
add_year argument. Defaults to volumetric cumulative flows, can use use_yield and basin_area to convert to
water yield. Returns a list of plots.
plot_daily_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE, add_year )plot_daily_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE, add_year )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
use_yield |
Logical value indicating whether to calculate area-based water yield, in mm, instead of volumetric discharge.
Default |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
add_year |
Numeric value indicating a year of daily flows to add to the daily statistics plot. Leave blank
or set to |
A list of ggplot2 objects with the following for each station provided:
Daily_Cumulative_Stats |
a plot that contains daily cumulative flow statistics |
Default plots on each object:
Mean |
daily cumulative mean |
Median |
daily cumulative median |
Min-5 Percentile Range |
a ribbon showing the range of data between the daily cumulative minimum and 5th percentile |
5-25 Percentiles Range |
a ribbon showing the range of data between the daily cumulative 5th and 25th percentiles |
25-75 Percentiles Range |
a ribbon showing the range of data between the daily cumulative 25th and 75th percentiles |
75-95 Percentiles Range |
a ribbon showing the range of data between the daily cumulative 75th and 95th percentiles |
95 Percentile-Max Range |
a ribbon showing the range of data between the daily cumulative 95th percentile and the maximum |
'Year' Flows |
(optional) the daily cumulative flows for the designated year |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual daily yield statistics with default HYDAT basin area plot_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Plot annual daily yield statistics with custom basin area plot_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual daily yield statistics with default HYDAT basin area plot_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Plot annual daily yield statistics with custom basin area plot_daily_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }
Plots means, medians, maximums, minimums, and percentiles for each day of the year of flow values
from a daily streamflow data set. Can determine statistics of rolling mean days (e.g. 7-day flows) using the roll_days
argument. Calculates statistics from all values, unless specified. The Maximum-Minimum band can be removed using the
plot_extremes argument and the percentile bands can be customized using the inner_percentiles and
outer_percentiles arguments. Data calculated using calc_daily_stats() function. Returns a list of plots.
plot_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12, ignore_missing = FALSE, plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), add_year, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )plot_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, complete_years = FALSE, months = 1:12, ignore_missing = FALSE, plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), add_year, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
months |
Numeric vector of months to include in analysis. For example, |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
plot_extremes |
Logical value to indicate plotting a ribbon with the range of daily minimum and maximum flows.
Default |
plot_inner_percentiles |
Logical value indicating whether to plot the inner percentiles ribbon. Default |
plot_outer_percentiles |
Logical value indicating whether to plot the outer percentiles ribbon. Default |
inner_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
inner percentiles ribbon for plotting. Default |
outer_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
outer percentiles ribbon for plotting. Default |
add_year |
Numeric value indicating a year of daily flows to add to the daily statistics plot. Leave blank
or set to |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Daily_Stats |
a plot that contains daily flow statistics |
Default plots on each object:
Mean |
daily mean |
Median |
daily median |
25-75 Percentiles |
a ribbon showing the range of data between the daily 25th and 75th percentiles |
5-95 Percentiles |
a ribbon showing the range of data between the daily 5th and 95th percentiles |
Minimum-Maximum |
a ribbon showing the range of data between the daily minimum and maximums |
'Year' |
(on annual plots) the daily flows for the designated year |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot daily statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_daily_stats(data = flow_data, start_year = 1980) # Plot daily statistics using only years with no missing data plot_daily_stats(station_number = "08NM116", complete_years = TRUE) # Plot daily statistics and add a specific year's daily flows plot_daily_stats(station_number = "08NM116", start_year = 1980, add_year = 1985) # Plot daily statistics for 7-day flows for July-September months only plot_daily_stats(station_number = "08NM116", start_year = 1980, roll_days = 7, months = 7:9) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot daily statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_daily_stats(data = flow_data, start_year = 1980) # Plot daily statistics using only years with no missing data plot_daily_stats(station_number = "08NM116", complete_years = TRUE) # Plot daily statistics and add a specific year's daily flows plot_daily_stats(station_number = "08NM116", start_year = 1980, add_year = 1985) # Plot daily statistics for 7-day flows for July-September months only plot_daily_stats(station_number = "08NM116", start_year = 1980, roll_days = 7, months = 7:9) }
Plots the mean, median, maximum, minimum, standard deviation of annual flows and indicates data availability.
Calculates statistics from all values, unless specified. Data calculated using screen_flow_data() function.
Returns a list of plots.
plot_data_screening( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, months = 1:12, start_year, end_year, include_title = FALSE, plot_availability = TRUE, include_stats = c("Mean", "Median", "Minimum", "Maximum", "Standard Deviation") )plot_data_screening( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, months = 1:12, start_year, end_year, include_title = FALSE, plot_availability = TRUE, include_stats = c("Mean", "Median", "Minimum", "Maximum", "Standard Deviation") )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
months |
Numeric vector of months to include in analysis. For example, |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
plot_availability |
Logical value specifying whether to indicate if years contain complete data or missing values.
Default |
include_stats |
Vector of one or all of |
A list of ggplot2 objects with the following for each station provided:
Data_Screening |
a plot that contains annual summary statistics for screening |
Default plots on each object:
Minimum |
annual minimum of all daily flows for a given year |
Maximum |
annual maximum of all daily flows for a given year |
Mean |
annual mean of all daily flows for a given year |
StandardDeviation |
annual 1 standard deviation of all daily flows for a given year |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot screening statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_data_screening(data = flow_data) # Plot screening statistics using station_number argument with defaults plot_data_screening(station_number = "08NM116") # Plot screening statistics for water years starting in October plot_data_screening(station_number = "08NM116", water_year_start = 10) # Plot screening statistics for 7-day flows for July-September months only plot_data_screening(station_number = "08NM116", roll_days = 7, months = 7:9) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot screening statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_data_screening(data = flow_data) # Plot screening statistics using station_number argument with defaults plot_data_screening(station_number = "08NM116") # Plot screening statistics for water years starting in October plot_data_screening(station_number = "08NM116", water_year_start = 10) # Plot screening statistics for 7-day flows for July-September months only plot_data_screening(station_number = "08NM116", roll_days = 7, months = 7:9) }
Plot the daily mean flow values from a streamflow data set. Plots daily discharge values
from all years, unless specified. Can choose specific dates to start and end plotting. Can choose to plot out each year
separately. Multiple groups/stations can be plotted if provided with the groups argument. Returns a list of plots.
plot_flow_data( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, start_date, end_date, log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), plot_by_year = FALSE, one_plot = FALSE, include_title = FALSE )plot_flow_data( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, start_date, end_date, log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), plot_by_year = FALSE, one_plot = FALSE, include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in plotting For example, |
start_date |
Date (YYYY-MM-DD) of first date to consider for plotting. Leave blank if all years are required. |
end_date |
Date (YYYY-MM-DD) of last date to consider for plotting. Leave blank if all years are required. |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when using a log-scale discharge axis.
Default to |
plot_by_year |
Logical value to indicate whether to plot each year of data individually. Default |
one_plot |
Logical value to indicate whether to plot all groups/stations on one plot. Default |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A ggplot2 object of daily flows from flow_data or HYDAT flow data provided
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot data from a data frame and data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_flow_data(data = flow_data) # Plot data directly from HYDAT plot_flow_data(station_number = "08NM116") # Plot statistics with custom years plot_flow_data(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995)) # Plot data multiple groups on one plot plot_flow_data(station_number = c("08NM241", "08NM242"), one_plot = TRUE) # Plot data between specific dates plot_flow_data(station_number = "08NM116", start_date = "1990-01-01", end_date = "1990-06-01") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot data from a data frame and data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_flow_data(data = flow_data) # Plot data directly from HYDAT plot_flow_data(station_number = "08NM116") # Plot statistics with custom years plot_flow_data(station_number = "08NM116", start_year = 1981, end_year = 2010, exclude_years = c(1991,1993:1995)) # Plot data multiple groups on one plot plot_flow_data(station_number = c("08NM241", "08NM242"), one_plot = TRUE) # Plot data between specific dates plot_flow_data(station_number = "08NM116", start_date = "1990-01-01", end_date = "1990-06-01") }
Plots data symbols for a daily data set. A column of symbols is required, default symbols = 'Symbol'.
For HYDAT data, symbols include: 'E' Estimate, 'A' Partial Day, 'B' Ice Conditions, 'D' Dry, and 'R' Revised.
Other symbols or categories may be used to colour points of plot.
Returns a list of plots.
plot_flow_data_symbols( data, dates = Date, values = Value, groups = STATION_NUMBER, symbols = Symbol, station_number, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, start_date, end_date, log_discharge = FALSE, include_title = FALSE )plot_flow_data_symbols( data, dates = Date, values = Value, groups = STATION_NUMBER, symbols = Symbol, station_number, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, start_date, end_date, log_discharge = FALSE, include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
symbols |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in plotting For example, |
start_date |
Date (YYYY-MM-DD) of first date to consider for plotting. Leave blank if all years are required. |
end_date |
Date (YYYY-MM-DD) of last date to consider for plotting. Leave blank if all years are required. |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Flow_Data_Symbols |
a plot that contains the flow data with symbol categories |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot data and symbols from a data frame and data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_flow_data_symbols(data = flow_data) # Plot data and symbols using station_number argument with defaults plot_flow_data_symbols(station_number = "08NM116") }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot data and symbols from a data frame and data argument flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_flow_data_symbols(data = flow_data) # Plot data and symbols using station_number argument with defaults plot_flow_data_symbols(station_number = "08NM116") }
Plots flow duration curves of flow data from a daily streamflow data set. Plots the percent time flows are
equalled or exceeded. Calculates statistics from all values, unless specified. Data calculated using
calc_longterm_stats() function then converted for plotting. Returns a list of plots.
plot_flow_duration( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, custom_months, custom_months_label, complete_years = FALSE, ignore_missing = FALSE, months = 1:12, include_longterm = TRUE, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )plot_flow_duration( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, custom_months, custom_months_label, complete_years = FALSE, ignore_missing = FALSE, months = 1:12, include_longterm = TRUE, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
custom_months |
Numeric vector of months to combine to summarize (ex. |
custom_months_label |
Character string to label custom months. For example, if |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
months |
Numeric vector of month curves to plot. |
include_longterm |
Logical value indicating whether to include long-term curve of all data. Default |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Flow_Duration |
a plot that contains flow duration curves for each month, long-term, and (option) customized months |
## Not run: # Working examples: # Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot flow durations using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_flow_duration(data = flow_data, start_year = 1980) # Plot flow durations using station_number argument with defaults plot_flow_duration(station_number = "08NM116", start_year = 1980) # Plot flow durations and add custom stats for July-September plot_flow_duration(station_number = "08NM116", start_year = 1980, custom_months = 7:9, custom_months_label = "Summer") } ## End(Not run)## Not run: # Working examples: # Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot flow durations using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_flow_duration(data = flow_data, start_year = 1980) # Plot flow durations using station_number argument with defaults plot_flow_duration(station_number = "08NM116", start_year = 1980) # Plot flow durations and add custom stats for July-September plot_flow_duration(station_number = "08NM116", start_year = 1980, custom_months = 7:9, custom_months_label = "Summer") } ## End(Not run)
Plots the long-term mean, median, maximum, minimum, and percentiles of daily flow values for over all months and
all data (Long-term) from a daily streamflow data set. Calculates statistics from all values, unless specified.
The Maximum-Minimum band can be removed using the plot_extremes argument and the percentile bands can be
customized using the inner_percentiles and outer_percentiles arguments. Data calculated using the
calc_longterm_daily_stats() function. Returns a list of plots.
plot_longterm_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), add_year, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )plot_longterm_daily_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), add_year, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
plot_extremes |
Logical value to indicate plotting a ribbon with the range of daily minimum and maximum flows.
Default |
plot_inner_percentiles |
Logical value indicating whether to plot the inner percentiles ribbon. Default |
plot_outer_percentiles |
Logical value indicating whether to plot the outer percentiles ribbon. Default |
inner_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
inner percentiles ribbon for plotting. Default |
outer_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
outer percentiles ribbon for plotting. Default |
add_year |
Numeric value indicating a year of daily flows to add to the daily statistics plot. Leave blank
or set to |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Long-term_Monthly_Statistics |
a plot that contains long-term flow statistics |
Default plots on each object:
Monthly Mean |
mean of all annual monthly means for a given month over all years |
Monthly Median |
median of all annual monthly means for a given month over all years |
25-75 Percentiles Range |
a ribbon showing the range of data between the monthly 25th and 75th percentiles |
5-95 Percentiles Range |
a ribbon showing the range of data between the monthly 5th and 95th percentiles |
Max-Min Range |
a ribbon showing the range of data between the monthly minimum and maximums |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot longterm daily statistics using data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_longterm_daily_stats(data = flow_data, start_year = 1980) # Plot longterm daily statistics for water years starting in October plot_longterm_daily_stats(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot longterm daily statistics using data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_longterm_daily_stats(data = flow_data, start_year = 1980) # Plot longterm daily statistics for water years starting in October plot_longterm_daily_stats(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10) }
Plots the long-term mean, median, maximum, minimum, and percentiles of annual monthly mean flow values for all
months and all data (Long-term) from a daily streamflow data set. Calculates statistics from all values, unless specified.
The Maximum-Minimum band can be removed using the plot_extremes argument and the percentile bands
can be customized using the inner_percentiles and outer_percentiles arguments. Data calculated using the
calc_longterm_monthly_stats() function. Returns a list of plots.
plot_longterm_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), add_year, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )plot_longterm_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), add_year, log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
plot_extremes |
Logical value to indicate plotting a ribbon with the range of daily minimum and maximum flows.
Default |
plot_inner_percentiles |
Logical value indicating whether to plot the inner percentiles ribbon. Default |
plot_outer_percentiles |
Logical value indicating whether to plot the outer percentiles ribbon. Default |
inner_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
inner percentiles ribbon for plotting. Default |
outer_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
outer percentiles ribbon for plotting. Default |
add_year |
Numeric value indicating a year of daily flows to add to the daily statistics plot. Leave blank
or set to |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects with the following for each station provided:
Long-term_Monthly_Statistics |
a plot that contains long-term flow statistics |
Default plots on each object:
Monthly Mean |
mean of all annual monthly means for a given month over all years |
Monthly Median |
median of all annual monthly means for a given month over all years |
25-75 Percentiles Range |
a ribbon showing the range of data between the monthly 25th and 75th percentiles |
5-95 Percentiles Range |
a ribbon showing the range of data between the monthly 5th and 95th percentiles |
Max-Min Range |
a ribbon showing the range of data between the monthly minimum and maximums |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot longterm monthly statistics using station_number argument with defaults plot_longterm_monthly_stats(station_number = "08NM116", start_year = 1980) # Plot longterm monthly statistics and add a specific year's daily flows plot_longterm_monthly_stats(station_number = "08NM116", start_year = 1980, add_year = 1985) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot longterm monthly statistics using station_number argument with defaults plot_longterm_monthly_stats(station_number = "08NM116", start_year = 1980) # Plot longterm monthly statistics and add a specific year's daily flows plot_longterm_monthly_stats(station_number = "08NM116", start_year = 1980, add_year = 1985) }
Plots the data availability for each month of each year. Calculates statistics from all values, unless specified.
Data calculated using screen_flow_data() function. Returns a list of plots.
plot_missing_dates( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, months = 1:12, include_title = FALSE, plot_type = "tile" )plot_missing_dates( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, months = 1:12, include_title = FALSE, plot_type = "tile" )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
months |
Numeric vector of months to include in analysis. For example, |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
plot_type |
Type of missing data plot, either |
A list of ggplot2 objects with the following for each station provided:
Missing_Dates |
a plot that contains the data availability for each year and month |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot missing dates using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_missing_dates(data = flow_data) # Plot missing dates using station_number argument with defaults plot_missing_dates(station_number = "08NM116") # Plot missing dates for 7-day flows for July-September months only plot_missing_dates(station_number = "08NM116", roll_days = 7, months = 7:9) # Plot missing dates for water years starting in October plot_missing_dates(station_number = "08NM116", water_year_start = 10) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot missing dates using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") plot_missing_dates(data = flow_data) # Plot missing dates using station_number argument with defaults plot_missing_dates(station_number = "08NM116") # Plot missing dates for 7-day flows for July-September months only plot_missing_dates(station_number = "08NM116", roll_days = 7, months = 7:9) # Plot missing dates for water years starting in October plot_missing_dates(station_number = "08NM116", water_year_start = 10) }
Plot the monthly cumulative mean, median, maximum, minimum, and 5, 25, 75, 95th percentiles for each month of the year
from a daily streamflow data set. Calculates statistics from all values from complete years, unless specified.
Data calculated using calc_monthly_cumulative_stats() function. Can plot individual years for comparison using the
add_year argument. Defaults to volumetric cumulative flows, can use use_yield and basin_area to convert to
water yield. Returns a list of plots.
plot_monthly_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE, add_year )plot_monthly_cumulative_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, use_yield = FALSE, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), include_title = FALSE, add_year )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
use_yield |
Logical value indicating whether to calculate area-based water yield, in mm, instead of volumetric discharge.
Default |
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
add_year |
Numeric value indicating a year of daily flows to add to the daily statistics plot. Leave blank
or set to |
A list of ggplot2 objects with the following for each station provided:
Monthly_Cumulative_Stats |
a plot that contains monthly cumulative flow statistics |
Default plots on each object:
Mean |
monthly cumulative mean |
Median |
monthly cumulative median |
Min-5 Percentile Range |
a ribbon showing the range of data between the monthly cumulative minimum and 5th percentile |
5-25 Percentiles Range |
a ribbon showing the range of data between the monthly cumulative 5th and 25th percentiles |
25-75 Percentiles Range |
a ribbon showing the range of data between the monthly cumulative 25th and 75th percentiles |
75-95 Percentiles Range |
a ribbon showing the range of data between the monthly cumulative 75th and 95th percentiles |
95 Percentile-Max Range |
a ribbon showing the range of data between the monthly cumulative 95th percentile and the maximum |
'Year' Flows |
(optional) the monthly cumulative flows for the designated year |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual cumulative volume statistics plot_monthly_cumulative_stats(station_number = "08NM116") # Plot annual cumulative yield statistics with default HYDAT basin area plot_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Plot annual cumulative yield statistics with custom basin area plot_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot annual cumulative volume statistics plot_monthly_cumulative_stats(station_number = "08NM116") # Plot annual cumulative yield statistics with default HYDAT basin area plot_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Plot annual cumulative yield statistics with custom basin area plot_monthly_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }
Plot monthly means and add long-term mean annual discharge percentages. Calculates statistics
from all values, unless specified. Mean data calculated using calc_longterm_daily_stats() function.
Returns a list of plots.
plot_monthly_means( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, plot_months = 1:12, complete_years = FALSE, ignore_missing = FALSE, include_title = FALSE, percent_MAD = c(10, 20, 100) )plot_monthly_means( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, plot_months = 1:12, complete_years = FALSE, ignore_missing = FALSE, include_title = FALSE, percent_MAD = c(10, 20, 100) )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
plot_months |
Numeric vector of months to include on the plot after calculating statistics.
For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
percent_MAD |
Numeric vector of percentages of long-term mean annual discharge to add to the plot (ex. |
A list of ggplot2 objects for with the following plots for each station provided:
Annual_Means |
a plot that contains annual means with the long-term mean as the x-axis intercept |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot monthly means plot_monthly_means(station_number = "08NM116", complete_years = TRUE) # Plot mean flows with custom LTMADs plot_monthly_means(station_number = "08NM116", complete_years = TRUE, percent_MAD = c(5,10,20,100)) # Plot mean flows and plot just summer months plot_monthly_means(station_number = "08NM116", complete_years = TRUE, plot_months = 6:9) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot monthly means plot_monthly_means(station_number = "08NM116", complete_years = TRUE) # Plot mean flows with custom LTMADs plot_monthly_means(station_number = "08NM116", complete_years = TRUE, percent_MAD = c(5,10,20,100)) # Plot mean flows and plot just summer months plot_monthly_means(station_number = "08NM116", complete_years = TRUE, plot_months = 6:9) }
Plots means, medians, maximums, minimums, and percentiles for each month of all years of flow values
from a daily streamflow data set. Calculates statistics from all values, unless specified. Data calculated using the
calc_monthly_stats() function. Produces a list containing a plot for each statistic. Returns a list of plots.
plot_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), scales_discharge = "fixed", include_title = FALSE )plot_monthly_stats( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, percentiles, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), log_discharge = FALSE, log_ticks = ifelse(log_discharge, TRUE, FALSE), scales_discharge = "fixed", include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
percentiles |
Numeric vector of percentiles to calculate. Set to |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
scales_discharge |
String, either 'fixed' (all y-axis scales the same) or 'free' (each plot has their own scale).
Default |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects for each monthly statistic for each station provided that contain:
Monthly Mean Flows |
mean of all daily flows for a given month and year |
Monthly Median Flows |
median of all daily flows for a given month and year |
Monthly Maximum Flows |
maximum of all daily flows for a given month and year |
Monthly Minimum Flows |
minimum of all daily flows for a given month and year |
Monthly P'n' Flows |
(optional) each n-th percentile selected for a given month and year |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot monthly statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") results <- plot_monthly_stats(data = flow_data, start_year = 1980, percentiles = 10) # Plot monthly statistics for water years starting in October results <- plot_monthly_stats(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10, percentiles = 10) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot monthly statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") results <- plot_monthly_stats(data = flow_data, start_year = 1980, percentiles = 10) # Plot monthly statistics for water years starting in October results <- plot_monthly_stats(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10, percentiles = 10) }
Plots means, medians, maximums, minimums, and percentiles as ribbons for each month of all years of flow values
from a daily streamflow data set. Calculates statistics from all values, unless specified. Data calculated using the
calc_monthly_stats() function. Produces a list containing a plot for each statistic. Returns a list of plots.
plot_monthly_stats2( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), scales_discharge = "fixed", include_title = FALSE )plot_monthly_stats2( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, complete_years = FALSE, ignore_missing = FALSE, allowed_missing = ifelse(ignore_missing, 100, 0), plot_extremes = TRUE, plot_inner_percentiles = TRUE, plot_outer_percentiles = TRUE, inner_percentiles = c(25, 75), outer_percentiles = c(5, 95), log_discharge = TRUE, log_ticks = ifelse(log_discharge, TRUE, FALSE), scales_discharge = "fixed", include_title = FALSE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
allowed_missing |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a statistic (0 to 100 percent). If |
plot_extremes |
Logical value to indicate plotting a ribbon with the range of daily minimum and maximum flows.
Default |
plot_inner_percentiles |
Logical value indicating whether to plot the inner percentiles ribbon. Default |
plot_outer_percentiles |
Logical value indicating whether to plot the outer percentiles ribbon. Default |
inner_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
inner percentiles ribbon for plotting. Default |
outer_percentiles |
Numeric vector of two percentile values indicating the lower and upper limits of the
outer percentiles ribbon for plotting. Default |
log_discharge |
Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default |
log_ticks |
Logical value to indicate plotting logarithmic scale ticks when |
scales_discharge |
String, either 'fixed' (all y-axis scales the same) or 'free' (each plot has their own scale).
Default |
include_title |
Logical value to indicate adding the group/station number to the plot, if provided. Default |
A list of ggplot2 objects for each monthly statistic for each station provided that contain:
Monthly Mean Flows |
mean of all daily flows for a given month and year |
Monthly Median Flows |
median of all daily flows for a given month and year |
Monthly Maximum Flows |
maximum of all daily flows for a given month and year |
Monthly Minimum Flows |
minimum of all daily flows for a given month and year |
Monthly P'n' Flows |
(optional) each n-th percentile selected for a given month and year |
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot monthly statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") results <- plot_monthly_stats2(data = flow_data, start_year = 1980) # Plot monthly statistics for water years starting in October results <- plot_monthly_stats2(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Plot monthly statistics using a data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") results <- plot_monthly_stats2(data = flow_data, start_year = 1980) # Plot monthly statistics for water years starting in October results <- plot_monthly_stats2(station_number = "08NM116", start_year = 1980, end_year = 2010, water_year_start = 10) }
Calculates means, medians, maximums, minimums, standard deviations of annual flows and data availability and missing data statistics, and symbol counts (if column exists) for each year and month of each year. Calculates the statistics from all daily discharge values from all years, unless specified. Returns a tibble with statistics.
screen_flow_data( data, dates = Date, values = Value, groups = STATION_NUMBER, symbols = "Symbol", station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, months = 1:12, transpose = FALSE, include_symbols = TRUE )screen_flow_data( data, dates = Date, values = Value, groups = STATION_NUMBER, symbols = "Symbol", station_number, roll_days = 1, roll_align = "right", water_year_start = 1, start_year, end_year, months = 1:12, transpose = FALSE, include_symbols = TRUE )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
symbols |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
roll_days |
Numeric value of the number of days to apply a rolling mean. Default |
roll_align |
Character string identifying the direction of the rolling mean from the specified date, either by the first
( |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
months |
Numeric vector of months to include in analysis. For example, |
transpose |
Logical value indicating whether to transpose rows and columns of results. Default |
include_symbols |
Logical. Include columns of counts of symbol categories from the symbols column. |
A tibble data frame with the following columns:
Year |
calendar or water year selected |
n_days |
number of days per year |
n_Q |
number of days per year with flow data |
n_missing_Q |
number of days per year with no flow data |
No_Symbol |
number of days with no symbol category, if include_symbol=TRUE |
x_Symbol |
number of days with a specific symbol category (x) from symbols column, if include_symbol=TRUE |
Maximum |
annual maximum of all daily flows for a given year |
Mean |
annual mean of all daily flows for a given year |
Median |
annual median of all daily flows for a given year |
StandardDeviation |
annual 1 standard deviation of all daily flows for a given year |
and the following monthly missing columns (order will depend on water_year_month):
Jan_missing_Q |
number of Jan days per year with no flow data |
Feb_missing_Q |
number of Feb days per year with no flow data |
Mar_missing_Q |
number of Mar days per year with no flow data |
Apr_missing_Q |
number of Apr days per year with no flow data |
May_missing_Q |
number of May days per year with no flow data |
Jun_missing_Q |
number of Jun days per year with no flow data |
Jul_missing_Q |
number of Jul days per year with no flow data |
Aug_missing_Q |
number of Aug days per year with no flow data |
Sep_missing_Q |
number of Sep days per year with no flow data |
Oct_missing_Q |
number of Oct days per year with no flow data |
Nov_missing_Q |
number of Nov days per year with no flow data |
Dec_missing_Q |
number of Dec days per year with no flow data |
Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate screening statistics using data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") screen_flow_data(data = flow_data) # Calculate screening statistics using station_number argument with defaults screen_flow_data(station_number = "08NM116") # Calculate screening statistics for water years starting in October screen_flow_data(station_number = "08NM116", water_year_start = 9) # Calculate screening statistics for 7-day flows for July-September months only screen_flow_data(station_number = "08NM116", roll_days = 7, months = 7:9) }# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate screening statistics using data frame and data argument with defaults flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") screen_flow_data(data = flow_data) # Calculate screening statistics using station_number argument with defaults screen_flow_data(station_number = "08NM116") # Calculate screening statistics for water years starting in October screen_flow_data(station_number = "08NM116", water_year_start = 9) # Calculate screening statistics for 7-day flows for July-September months only screen_flow_data(station_number = "08NM116", roll_days = 7, months = 7:9) }
Write a daily streamflow data set to a directory. Can fill missing dates or filter data by years or dates before
writing using given arguments. List data frame or HYDAT station number to write its entirety. Can write as .xls, .xlsx, or .csv
file types. Writing as Excel file type uses the writexl package.
write_flow_data( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, water_year_start = 1, start_year, end_year, start_date, end_date, file_name, fill_missing = FALSE, digits )write_flow_data( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, water_year_start = 1, start_year, end_year, start_date, end_date, file_name, fill_missing = FALSE, digits )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year of data to write. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year of data to write. Leave blank or set well after end date (i.e.
|
start_date |
Date (YYYY-MM-DD) of first date of data to write. Leave blank or set well before start date (i.e.
|
end_date |
Date (YYYY-MM-DD) of last date of data to write. Leave blank or set well after end date (i.e.
|
file_name |
Character string naming the output file. If none provided, a default file name (with .xlsx) is provided (see "Successfully created" message when using function for file name). |
fill_missing |
Logical value indicating whether to fill dates with missing flow data with NA. Default |
digits |
Integer indicating the number of decimal places or significant digits used to round flow values. Use follows that of base::round() digits argument. |
## Not run: # Working examples: # Write data from a data frame flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") write_flow_data(data = flow_data, file_name = "Mission_Creek_daily_flows.xlsx") # Write data directly from HYDAT write_flow_data(station_number = "08NM116", file_name = "Mission_Creek_daily_flows.xlsx") # Write data directly from HYDAT and fill missing dates with NA write_flow_data(station_number = "08NM116", file_name = "Mission_Creek_daily_flows.xlsx", fill_missing = TRUE) ## End(Not run)## Not run: # Working examples: # Write data from a data frame flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116") write_flow_data(data = flow_data, file_name = "Mission_Creek_daily_flows.xlsx") # Write data directly from HYDAT write_flow_data(station_number = "08NM116", file_name = "Mission_Creek_daily_flows.xlsx") # Write data directly from HYDAT and fill missing dates with NA write_flow_data(station_number = "08NM116", file_name = "Mission_Creek_daily_flows.xlsx", fill_missing = TRUE) ## End(Not run)
Calculates and writes tables and plots from a suite of statistics from fasstr functions into
an Excel workbook, and accompanying plot files for certain analyses. Due to the number of tables and plots to be made, this
function may take several minutes to complete. If ignore_missing = FALSE (default) and there is missing data,
some tables and plots may be empty and produce warnings. Use ignore_missing = TRUE to ignore the missing values or
filter your data to complete years. Calculates statistics from all values, unless specified. Returns a list of tibbles and
plots, along with saving the Excel and image files in a directory.
write_full_analysis( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, analyses = 1:7, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, ignore_missing = FALSE, complete_years = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0), zyp_method = "zhang", zyp_alpha, file_name, plot_filetype = "pdf" )write_full_analysis( data, dates = Date, values = Value, groups = STATION_NUMBER, station_number, analyses = 1:7, basin_area, water_year_start = 1, start_year, end_year, exclude_years, months = 1:12, ignore_missing = FALSE, complete_years = FALSE, allowed_missing_annual = ifelse(ignore_missing, 100, 0), allowed_missing_monthly = ifelse(ignore_missing, 100, 0), zyp_method = "zhang", zyp_alpha, file_name, plot_filetype = "pdf" )
data |
Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers).
Leave blank or set to |
dates |
Name of column in |
values |
Name of column in |
groups |
Name of column in |
station_number |
Character string vector of seven digit Water Survey of Canada station numbers (e.g. |
analyses |
Numeric vector of analyses to run (default is all (
|
basin_area |
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such |
water_year_start |
Numeric value indicating the month ( |
start_year |
Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e.
|
end_year |
Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e.
|
exclude_years |
Numeric vector of years to exclude from analysis. Leave blank or set to |
months |
Numeric vector of months to include in analysis. For example, |
ignore_missing |
Logical value indicating whether dates with missing values should be included in the calculation. If
|
complete_years |
Logical values indicating whether to include only years with complete data in analysis. Default |
allowed_missing_annual |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate an annual statistic (0 to 100 percent). If |
allowed_missing_monthly |
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a monthly statistic (0 to 100 percent). If |
zyp_method |
Character string identifying the prewhitened trend method to use from |
zyp_alpha |
Numeric value of the significance level (ex. |
file_name |
Character string of the name of the Excel Workbook (and folder for plots if necessary) to create on drive to write all results. |
plot_filetype |
Image type to write. One of |
compute_full_analysis,
screen_flow_data,
plot_data_screening,
plot_missing_dates,
calc_longterm_monthly_stats,
plot_longterm_monthly_stats,
calc_longterm_daily_stats,
plot_longterm_daily_stats,
plot_monthly_means,
plot_flow_duration,
calc_annual_stats,
plot_annual_stats,
calc_annual_cumulative_stats,
plot_annual_cumulative_stats,
calc_annual_flow_timing,
plot_annual_flow_timing,
calc_annual_normal_days,
plot_annual_normal_days,
calc_annual_lowflows,
plot_annual_lowflows,
plot_annual_means,
calc_monthly_stats,
plot_monthly_stats,
calc_monthly_cumulative_stats,
plot_monthly_cumulative_stats,
calc_daily_stats,
plot_daily_stats,
calc_daily_cumulative_stats,
plot_daily_cumulative_stats,
compute_annual_trends,
compute_annual_frequencies,
write_flow_data,
write_plots
## Not run: # Working examples: # Save a full analysis will all the analyses write_full_analysis(station_number = "08NM116", file_name = "Mission Creek", start_year = 1980, end_year = 2010) # Save a full analysis with only Annual and Daily analyses write_full_analysis(station_number = "08NM116", file_name = "Mission Creek", start_year = 1980, end_year = 2010, analyses = c(3,5)) ## End(Not run)## Not run: # Working examples: # Save a full analysis will all the analyses write_full_analysis(station_number = "08NM116", file_name = "Mission Creek", start_year = 1980, end_year = 2010) # Save a full analysis with only Annual and Daily analyses write_full_analysis(station_number = "08NM116", file_name = "Mission Creek", start_year = 1980, end_year = 2010, analyses = c(3,5)) ## End(Not run)
Write a list of tables (data frames) and plots (ggplots; as used by fasstr) into a directory. Objects
that are not class "data.frame" or "gg" will not be saved. Each table and plot will be named by the object name in the list.
write_objects_list( list, folder_name, table_filetype, plot_filetype, width, height, units = "in", dpi = 300 )write_objects_list( list, folder_name, table_filetype, plot_filetype, width, height, units = "in", dpi = 300 )
list |
List of data frames and plots to write to disk. |
folder_name |
Name of folder to create on disk (if it does not exist) to write each plot from list.
If using |
table_filetype |
Table file type to write. One of |
plot_filetype |
Image type to write. One of |
width |
Numeric plot width in |
height |
Numeric plot height in |
units |
Character string plot height and width units, one of |
dpi |
Numeric resolution of plots. Default |
## Not run: # Working examples: # Example list of tables and plots to save frequency <- compute_annual_frequencies(station_number = "08NM116") # Write objects in a folder write_objects_list(list = frequency, folder_name = "Frequency Analysis", table_filetype = "xlsx", plot_filetype = "png") ## End(Not run)## Not run: # Working examples: # Example list of tables and plots to save frequency <- compute_annual_frequencies(station_number = "08NM116") # Write objects in a folder write_objects_list(list = frequency, folder_name = "Frequency Analysis", table_filetype = "xlsx", plot_filetype = "png") ## End(Not run)
Write a list of plots (ggplots; as used by fasstr) into a directory or PDF document.
When writing into a named directory each plot will be named by the plot name listed in the list; uses ggplot2::ggsave
function. When writing into a PDF document (combined_pdf == TRUE) the plot names will not appear; uses
grDevices::pdf function.
write_plots( plots, folder_name, plot_filetype, width, height, units = "in", dpi = 300, combined_pdf = FALSE )write_plots( plots, folder_name, plot_filetype, width, height, units = "in", dpi = 300, combined_pdf = FALSE )
plots |
List of plots to write to disk. |
folder_name |
Name of folder to create on disk (if it does not exist) to write each plot from list.
If using |
plot_filetype |
Image type to write. One of |
width |
Numeric plot width in |
height |
Numeric plot height in |
units |
Character string plot height and width units, one of |
dpi |
Numeric resolution of plots. Default |
combined_pdf |
Logical value indicating whether to combine list of plots into one PDF document. Default |
## Not run: # Working examples: # Example plots to save plots <- plot_annual_lowflows(station_number = "08NM116") # Write the plots as "png" files write_plots(plots = plots, folder_name = "Low Flow Plots", plot_filetype = "png") # Write the plots as a combined "pdf" document write_plots(plots = plots, folder_name = "Low Flow Plots", combined_pdf = TRUE) ## End(Not run)## Not run: # Working examples: # Example plots to save plots <- plot_annual_lowflows(station_number = "08NM116") # Write the plots as "png" files write_plots(plots = plots, folder_name = "Low Flow Plots", plot_filetype = "png") # Write the plots as a combined "pdf" document write_plots(plots = plots, folder_name = "Low Flow Plots", combined_pdf = TRUE) ## End(Not run)
Write a data frame to a directory with all numbers rounded to specified digits. Can write as .xls, .xlsx, or .csv
file types. Writing as .xlsx or .xls uses the writexl package.
write_results(data, file_name, digits)write_results(data, file_name, digits)
data |
Data frame to be written to a directory. |
file_name |
Character string naming the output file. Required. |
digits |
Integer indicating the number of decimal places or significant digits used to round flow values. Use follows
that of |
## Not run: # Working examples: # Example data to write data_results <- calc_longterm_daily_stats(station_number = c("08HA002", "08HA011"), start_year = 1971, end_year = 2000) # Write the data and round numbers to 1 decimal place write_results(data = data_results, file_name = "Cowichan River Long-term Flows (1971-2000).xlsx", digits = 1) ## End(Not run)## Not run: # Working examples: # Example data to write data_results <- calc_longterm_daily_stats(station_number = c("08HA002", "08HA011"), start_year = 1971, end_year = 2000) # Write the data and round numbers to 1 decimal place write_results(data = data_results, file_name = "Cowichan River Long-term Flows (1971-2000).xlsx", digits = 1) ## End(Not run)