fasstr (version 0.3.1)

calc_daily_cumulative_stats: Calculate cumulative daily flow statistics

Description

Calculate cumulative daily flow statistics for each day of the year of daily flow values from a streamflow dataset. Calculates the statistics from all daily discharge values from all years, unless specified. Defaults to volumetric cumulative flows, can use use_yield and basin_area to convert to runoff yield.

Usage

calc_daily_cumulative_stats(
  data,
  dates = Date,
  values = Value,
  groups = STATION_NUMBER,
  station_number,
  percentiles = c(5, 25, 75, 95),
  use_yield = FALSE,
  basin_area,
  water_year_start = 1,
  start_year,
  end_year,
  exclude_years,
  transpose = FALSE
)

Arguments

data

A data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers). Leave blank if using station_number argument.

dates

Column in data that contains dates formatted YYYY-MM-DD. Only required if dates column name is not ' Date' (default). Leave blank if using station_number argument.

values

Column in data that contains numeric flow values, in units of cubic metres per second. Only required if values column name is not 'Value' (default). Leave blank if using station_number argument.

groups

Column in data that contains unique identifiers for different data sets, if applicable. Only required if groups column name is not 'STATION_NUMBER'. Function will automatically group by a column named 'STATION_NUMBER' if present. Remove the 'STATION_NUMBER' column beforehand to remove this grouping. Leave blank if using station_number argument.

station_number

A character string vector of seven digit Water Survey of Canada station numbers (e.g. "08NM116") of which to extract daily streamflow data from a HYDAT database. Requires tidyhydat package and a HYDAT database. Leave blank if using data argument.

percentiles

Numeric vector of percentiles to calculate. Set to NA if none required. Default c(5,25,75,95).

use_yield

Logical value indicating whether to use yield runoff, in mm, instead of volumetric. Default FALSE.

basin_area

Upstream drainage basin area, in square kilometres, to apply to observations. Three options:

(1) Leave blank if groups is STATION_NUMBER with HYDAT station numbers to extract basin areas from HYDAT.

(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 c("08NM116" = 795, "08NM242" = 10). If group is not listed the HYDAT area will be applied if it exists, otherwise it will be NA.

water_year_start

Numeric value indicating the month of the start of the water year for analysis. Default 1.

start_year

Numeric value of the first year to consider for analysis. Leave blank to use the first year of the source data.

end_year

Numeric value of the last year to consider for analysis. Leave blank to use the last year of the source data.

exclude_years

Numeric vector of years to exclude from analysis. Leave blank to include all years.

transpose

Logical value indicating if the results rows and columns are to be switched. Default FALSE.

Value

A data frame with the following columns, default units in cubic metres, millimetres if use_yield and basin_area provided:

Date

date (MMM-DD) of daily cumulative statistics

DayofYear

day of year of daily cumulative statistics

Mean

daily mean of all cumulative flows for a given day of the year

Median

daily mean of all cumulative flows for a given day of the year

Maximum

daily mean of all cumulative flows for a given day of the year

Minimum

daily mean of all cumulative flows for a given day of the year

P'n'

each daily n-th percentile selected of all cumulative flows for a given day of the year

Default percentile columns:

P5

daily 5th percentile of all cumulative flows for a given day of the year

P25

daily 25th percentile of all cumulative flows for a given day of the year

P75

daily 75th percentile of all cumulative flows for a given day of the year

P95

daily 95th percentile of all cumulative flows for a given day of the year

Transposing data creates a column of "Statistics" and subsequent columns for each year selected.

Examples

# NOT RUN {
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {

# Calculate annual daily cumulative volume statistics
calc_daily_cumulative_stats(station_number = "08NM116") 

# Calculate annual daily cumulative yield statistics 
# with default HYDAT basin area
calc_daily_cumulative_stats(station_number = "08NM116",
                            use_yield = TRUE) 

# Calculate annual daily cumulative yield statistics 
# with custom basin area
calc_daily_cumulative_stats(station_number = "08NM116",
                            use_yield = TRUE,
                            basin_area = 800) 
                            
}
# }