View source: R/plot_annual_flow_timing_year.R
plot_annual_flow_timing_year  R Documentation 
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)
)
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 (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_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 
calc_annual_flow_timing
plot_annual_flow_timing
# 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)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.