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