View source: R/plot_annual_stats.R
plot_annual_stats  R Documentation 
Plots means, medians, maximums, minimums, and percentiles for each year from all years of a daily streamflow
data set. Calculates statistics from all values, unless specified. Data calculated using calc_annual_stats()
function.
Returns a list of plots.
plot_annual_stats(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
percentiles,
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),
log_discharge = FALSE,
log_ticks = ifelse(log_discharge, TRUE, FALSE),
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. 
percentiles 
Numeric vector of percentiles to calculate. Set to 
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 
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 
A list of ggplot2 objects for with the following plots (percentile plots optional) for each station provided:
Annual_Stats 
a plot that contains annual statistics 
Default plots on each object:
Mean 
annual mean of all daily flows 
Median 
annual median of all daily flows 
Maximum 
annual maximum of all daily flows 
Minimum 
annual minimum of all daily flows 
calc_annual_stats
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Plot annual statistics using a data frame and data argument with defaults
flow_data < tidyhydat::hy_daily_flows(station_number = "08NM116")
plot_annual_stats(data = flow_data)
# Plot annual statistics using station_number argument with defaults
plot_annual_stats(station_number = "08NM116")
# Plot annual statistics regardless if there is missing data for a given year
plot_annual_stats(station_number = "08NM116",
ignore_missing = TRUE)
# Plot annual statistics for water years starting in October
plot_annual_stats(station_number = "08NM116",
water_year_start = 10)
# Plot annual statistics with custom years and percentiles
plot_annual_stats(station_number = "08NM116",
start_year = 1981,
end_year = 2010,
exclude_years = c(1991,1993:1995),
percentiles = c(25,75))
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.