View source: R/plot_annual_extremes.R
plot_annual_extremes  R Documentation 
Plots annual nday 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
)
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 JunAug). 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 JunAug). 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 nday rolling means 
Annual_Extreme_Flows_Dates 
ggplot2 object of the day of years of annual minimum and maximum flows of selected nday rolling means 
calc_annual_extremes
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Plot annual 1day (default) max/min flow data with
# default alignment ('right')
plot_annual_extremes(station_number = "08NM116")
# Plot custom annual 3day max and 7min flow data with 'center' alignment
plot_annual_extremes(station_number = "08NM116",
roll_days_max = 3,
roll_days_min = 7,
roll_align = "center")
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.