View source: R/plot_annual_cumulative_stats.R
plot_annual_cumulative_stats  R Documentation 
Plots annual and seasonal (if include_seaons = TRUE
) total flows, volumetric discharge or water yields, from a
daily streamflow data set. Calculates statistics from all values, unless specified. Data calculated from
plot_annual_cumulative_stats()
function. For water year and seasonal data, the designated year is the year in which the
year or season ends. Returns a list of plots.
plot_annual_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,
include_seasons = FALSE,
include_title = FALSE,
complete_years = FALSE,
plot_type = "bar"
)
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, 
include_seasons 
Logical value indication whether to include seasonal yields or volumetric discharges. Default 
include_title 
Logical value to indicate adding the group/station number to the plot, if provided. Default 
complete_years 
Logical values indicating whether to include only years with complete data in analysis. Default 
plot_type 
Type of plot, either 
A list of ggplot2 objects with the following for each station provided:
Annual_Total_Volume 
annual total volumetric discharge, in cubic metres 
Two_Seasons_Total_Volume 
if include_seasons = TRUE, two seasons total volumetric discharges, in cubic metres 
Four_Seasons_Total_Volume 
if include_seasons = TRUE, four seasons total volumetric discharges, in cubic metres 
If use_yield
argument is used the list will contain the following objects:
Annual_Yield 
annual water yield, in millimetres 
Two_Seasons_Yield 
if include_seasons = TRUE, two seasons water yield, in millimetres 
Four_Seasons_Yield 
if include_seasons = TRUE, four seasons water yield, in millimetres 
calc_annual_cumulative_stats
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Plot annual cumulative yield statistics with default HYDAT basin area
plot_annual_cumulative_stats(station_number = "08NM116",
use_yield = TRUE)
# Plot annual cumulative yield statistics with custom basin area
plot_annual_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.