View source: R/calc_all_annual_stats.R
calc_all_annual_stats  R Documentation 
Calculates annual statistics from all annual fasstr
functions from a daily streamflow data set.
Data is ideally longterm and continuous with minimal missing/seasonal data as annual statistics are calculated.
Calculates statistics from all values, unless specified. Returns a tibble with statistics.
Data calculated using the following functions:
calc_annual_stats()
calc_annual_lowflows()
calc_annual_cumulative_stats()
calc_annual_flow_timing()
calc_annual_normal_days()
calc_monthly_stats()
calc_all_annual_stats(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
basin_area,
water_year_start = 1,
start_year,
end_year,
exclude_years,
months = 1:12,
annual_percentiles = c(10, 90),
monthly_percentiles = c(10, 20),
stats_days = 1,
stats_align = "right",
lowflow_days = c(1, 3, 7, 30),
lowflow_align = "right",
timing_percent = c(25, 33, 50, 75),
normal_percentiles = c(25, 75),
transpose = FALSE,
complete_years = FALSE,
ignore_missing = FALSE,
allowed_missing_annual = ifelse(ignore_missing, 100, 0),
allowed_missing_monthly = ifelse(ignore_missing, 100, 0)
)
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. 
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, 
annual_percentiles 
Numeric vector of percentiles to calculate annually. Set to 
monthly_percentiles 
Numeric vector of percentiles to calculate monthly for each year. Set to 
stats_days 
Numeric vector of the number of days to apply a rolling mean on basic stats. Default 
stats_align 
Character string identifying the direction of the rolling mean on basic stats from the specified date, either by
the first ( 
lowflow_days 
Numeric vector of the number of days to apply a rolling mean on low flow stats. Default 
lowflow_align 
Character string identifying the direction of the rolling mean on low flow stats from the specified date,
either by the first ( 
timing_percent 
Numeric vector of percents of annual total flows to determine dates. Used for 
normal_percentiles 
Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the
normal range. 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 
ignore_missing 
Logical value indicating whether dates with missing values should be included in the calculation. If

allowed_missing_annual 
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate an annual statistic (0 to 100 percent). If 
allowed_missing_monthly 
Numeric value between 0 and 100 indicating the percentage of missing dates allowed to be
included to calculate a monthly statistic (0 to 100 percent). If 
A tibble data frame with column "Year" and then 107 (default) variables from the fasstr annual functions. See listed functions above for default variables. Transposing data creates a column of "Statistics" and subsequent columns for each year selected.
calc_annual_stats
,
calc_annual_lowflows
,
calc_annual_cumulative_stats
,
calc_annual_flow_timing
,
calc_monthly_stats
,
calc_annual_normal_days
## Not run:
# Working examples:
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Calculate all annual statistics from this package with default arguments
calc_all_annual_stats(station_number = "08NM116")
# Calculate all annual statistics from this package with default arguments
# with some default arguments shown to customize metrics
calc_all_annual_stats(station_number = "08NM116",
annual_percentiles = c(10,90),
monthly_percentiles = c(10,20),
stats_days = 1,
stats_align = "right",
lowflow_days = c(1,3,7,30),
lowflow_align = "right",
timing_percent = c(25,33,50,75),
normal_percentiles = c(25,75))
}
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.