View source: R/calc_annual_flow_timing.R
calc_annual_flow_timing  R Documentation 
Calculates the timing (day of year and date) of portions of total annual flow of daily flow values from a daily streamflow data set. Calculates statistics from all values from complete years, unless specified. Returns a tibble with statistics.
calc_annual_flow_timing(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
percent_total = c(25, 33.3, 50, 75),
water_year_start = 1,
start_year,
end_year,
exclude_years,
months = 1:12,
transpose = 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. 
percent_total 
Numeric vector of percents of total annual flows to determine dates. Default 
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, 
transpose 
Logical value indicating whether to transpose rows and columns of results. Default 
A tibble data frame with the following columns:
Year 
calendar or water year selected 
DoY_'n'pct_TotalQ 
day of year for each npercent of total volumetric discharge 
Date_'n'pct_TotalQ 
date (YYYYMMDD) for each npercent of total volumetric discharge 
Default columns:
DoY_25pct_TotalQ 
day of year of 25percent of total volumetric discharge 
Date_25pct_TotalQ 
date (YYYYMMDD) of 25percent of total volumetric discharge 
DoY_33.3pct_TotalQ 
day of year of 33.3percent of total volumetric discharge 
Date_33.3pct_TotalQ 
date (YYYYMMDD) of 33.3percent of total volumetric discharge 
DoY_50pct_TotalQ 
day of year of 50percent of total volumetric discharge 
Date_50pct_TotalQ 
date (YYYYMMDD) of 50percent of total volumetric discharge 
DoY_75pct_TotalQ 
day of year of 75percent of total volumetric discharge 
Date_75pct_TotalQ 
date (YYYYMMDD) of 75percent of total volumetric discharge 
Transposing data creates a column of 'Statistics' (just DoY, not Date values) and subsequent columns for each year selected.
Barnett, T.P., Pierce, D.W., Hidalgo, H.G., Bonfils, C., Santer, B.D., Das, T., Bala, G., Wood, A.W., Nozawa, T., Mirin, A.A., Cayan, D.R., Dettinger, M.D., 2008. HumanInduced Clanges in the Hydrology of the Western United States. Science 319, 10801083.
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Calculate annual flow timings with default percent of annual totals
calc_annual_flow_timing(station_number = "08NM116")
# Calculate annual flow timings with custom percent of annual totals
calc_annual_flow_timing(station_number = "08NM116",
percent_total = 50)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.