View source: R/plot_monthly_cumulative_stats.R
plot_monthly_cumulative_stats  R Documentation 
Plot the monthly cumulative mean, median, maximum, minimum, and 5, 25, 75, 95th percentiles for each month of the year
from a daily streamflow data set. Calculates statistics from all values from complete years, unless specified.
Data calculated using calc_monthly_cumulative_stats()
function. Can plot individual years for comparison using the
add_year argument. Defaults to volumetric cumulative flows, can use use_yield
and basin_area
to convert to
water yield. Returns a list of plots.
plot_monthly_cumulative_stats(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
use_yield = FALSE,
basin_area,
water_year_start = 1,
start_year,
end_year,
exclude_years,
months = 1:12,
log_discharge = FALSE,
log_ticks = ifelse(log_discharge, TRUE, FALSE),
include_title = FALSE,
add_year
)
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. 
use_yield 
Logical value indicating whether to calculate areabased water yield, in mm, instead of volumetric discharge.
Default 
basin_area 
Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (2) A single numeric value to apply to all observations. (3) List each basin area for each group/station in groups (can override HYDAT value if listed) as such 
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 
add_year 
Numeric value indicating a year of daily flows to add to the daily statistics plot. Leave blank
or set to 
A list of ggplot2 objects with the following for each station provided:
Monthly_Cumulative_Stats 
a plot that contains monthly cumulative flow statistics 
Default plots on each object:
Mean 
monthly cumulative mean 
Median 
monthly cumulative median 
Min5 Percentile Range 
a ribbon showing the range of data between the monthly cumulative minimum and 5th percentile 
525 Percentiles Range 
a ribbon showing the range of data between the monthly cumulative 5th and 25th percentiles 
2575 Percentiles Range 
a ribbon showing the range of data between the monthly cumulative 25th and 75th percentiles 
7595 Percentiles Range 
a ribbon showing the range of data between the monthly cumulative 75th and 95th percentiles 
95 PercentileMax Range 
a ribbon showing the range of data between the monthly cumulative 95th percentile and the maximum 
'Year' Flows 
(optional) the monthly cumulative flows for the designated year 
calc_monthly_cumulative_stats
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Plot annual cumulative volume statistics
plot_monthly_cumulative_stats(station_number = "08NM116")
# Plot annual cumulative yield statistics with default HYDAT basin area
plot_monthly_cumulative_stats(station_number = "08NM116",
use_yield = TRUE)
# Plot annual cumulative yield statistics with custom basin area
plot_monthly_cumulative_stats(station_number = "08NM116",
use_yield = TRUE,
basin_area = 800)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.