View source: R/plot_annual_extremes_year.R
plot_annual_extremes_year  R Documentation 
Plots an annual hydrograph for a specific year with the values and timing of annual nday 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)
)
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 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 
log_discharge 
Logical value to indicate plotting the discharge axis (Yaxis) 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 
calc_annual_extremes
plot_annual_extremes
# 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)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.