View source: R/plot_annual_means.R
plot_annual_means  R Documentation 
Plot annual means using the longterm 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)
)
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 longterm mean as the xaxis intercept 
calc_annual_stats
# 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 JulySeptember
plot_annual_means(station_number = "08NM116",
months = 7:9)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.