fasstr (version 0.3.1)

plot_annual_cumulative_stats: Plot annual and seasonal total flows

Description

Plots annual and seasonal total flows, volumetric or runoff yield flows, from a streamflow dataset. Calculates the statistics from all daily discharge values from all years, 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. For example, if using water years with a start month of 11, the OND season is designated by the water year which starts in November (designated by the calendar year in which it ends).

Usage

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,
  include_seasons = FALSE,
  log_discharge = FALSE,
  include_title = 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.

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.

include_seasons

Logical value indication whether to include seasonal yields and total discharges. Default TRUE.

log_discharge

Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default FALSE.

include_title

Logical value to indicate adding the group/station number to the plot, if provided. Default FALSE.

Value

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 runoff yield, in millimetres

Two_Seasons_Yield

if include_seasons = TRUE, two seasons runoff yields, in millimetres

Four_Seasons_Yield

if include_seasons = TRUE, four seasons runoff yields, in millimetres

See Also

calc_annual_cumulative_stats

Examples

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

# Plot annual cumulative volume statistics
plot_annual_cumulative_stats(station_number = "08NM116") 

# 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) 

# Plot annual cumulative yield statistics and seasonal totals
plot_annual_cumulative_stats(station_number = "08NM116",
                             use_yield = TRUE,
                             include_seasons = TRUE)
                             
}
# }