View source: R/calc_annual_cumulative_stats.R
calc_annual_cumulative_stats  R Documentation 
Calculates annual and seasonal total flows, as volumetric discharge or water yields, from a daily streamflow data set. For water year and seasonal data, the year is identified by the year in which the year or season ends. Twoseasons and fourseasons per year are calculated, with each 6 and 3month seasons starting with the first month of the year (Jan for calendar year, specified for water year). Each season is designated by the calendar or water year in which it occurs. Calculates statistics from all values from complete years, unless specified. Returns a tibble with statistics.
calc_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,
transpose = FALSE,
complete_years = 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. 
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 (e.g. 
include_seasons 
Logical value indication whether to include seasonal yields or volumetric discharges. Default 
transpose 
Logical value indicating whether to transpose rows and columns of results. Default 
complete_years 
Logical values indicating whether to include only years with complete data in analysis. Default 
A tibble data frame with the following columns, ending with '_Volume_m3' or '_Yield_mm' based on selection:
Year 
calendar or water year selected 
Total_* 
annual (or selected months) total flow, in m3 or mm 
Default seasonal columns:
MMMMMM_* 
first of two season total flows, in m3 or mm 
MMMMMM_* 
second of two season total flows, in m3 or mm 
MMMMMM_* 
first of four season total flows, in m3 or mm 
MMMMMM_* 
second of four season total flows, in m3 or mm 
MMMMMM_* 
third of four season total flows, in m3 or mm 
MMMMMM_* 
fourth of four season total flows, in m3 or mm 
Transposing data creates a column of 'Statistics' and subsequent columns for each year selected.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Calculate annual total volumetric flow statistics
calc_annual_cumulative_stats(station_number = "08NM116")
# Calculate annual total yield statistics with default HYDAT basin area
calc_annual_cumulative_stats(station_number = "08NM116",
use_yield = TRUE)
# Calculate annual total yield statistics with a custom basin area
calc_annual_cumulative_stats(station_number = "08NM116",
use_yield = TRUE,
basin_area = 800,
start_year = 1980)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.