Plot annual timing of flows for a specific year

Plots an annual hydrograph for a specific year with the dates of flow timing of portions of total annual flow identified. The 'normal' range of percentiles also plotted for reference and are calculated from only years of complete data. Shows the dates of flow timing for a specific year from the counts from the plot_annual_flow_timing() function. Returns a list of plots.

plot_annual_flow_timing_year(
  data,
  dates = Date,
  values = Value,
  groups = STATION_NUMBER,
  station_number,
  percent_total = c(25, 33.3, 50, 75),
  year_to_plot = NA,
  water_year_start = 1,
  start_year,
  end_year,
  exclude_years,
  months = 1:12,
  log_discharge = TRUE,
  log_ticks = FALSE,
  include_title = FALSE,
  plot_vlines = TRUE,
  plot_normal_percentiles = TRUE,
  normal_percentiles = c(25, 75)
)

Arguments

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 NULL if using station_number argument.
dates: Name of column in data that contains dates formatted YYYY-MM-DD. Only required if dates column name is not 'Date' (default). Leave blank or set to NULL if using station_number argument.
values: Name of 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: Name of 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: 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.
percent_total: Numeric vector of percents of total annual flows to determine dates. Default c(25,33.3,50,75).
year_to_plot: Numeric value indicating the year/water year to plot flow data with normal category colours. Default NA.
water_year_start: Numeric value indicating the month (1 through 12) of the start of water year for analysis. Default 1.
start_year: Numeric value of the first year to consider for analysis. Leave blank or set well before start date (i.e. 1800) to use from the first year of the source data.
end_year: Numeric value of the last year to consider for analysis. Leave blank or set well after end date (i.e. 2100) to use up to the last year of the source data.
exclude_years: Numeric vector of years to exclude from analysis. Leave blank or set to NULL to include all years.
months: Numeric vector of months to include in analysis. For example, 3 for March, 6:8 for Jun-Aug or c(10:12,1) for first four months (Oct-Jan) when water_year_start = 10 (Oct). Default summarizes all months (1:12).
log_discharge: Logical value to indicate plotting the discharge axis (Y-axis) on a logarithmic scale. Default FALSE.
log_ticks: Logical value to indicate plotting logarithmic scale ticks when log_discharge = TRUE. Ticks will not appear when log_discharge = FALSE. Default to TRUE when log_discharge = TRUE.
include_title: Logical value to indicate adding the group/station number to the plot, if provided. Default FALSE.
plot_vlines: Logical value indicating whether to plot the vertical lines indicating dates of flow timing. Default TRUE.
plot_normal_percentiles: Logical value indicating whether to plot the normal percentiles ribbon. Default TRUE.
normal_percentiles: Numeric vector of two values, lower and upper percentiles, respectively indicating the limits of the normal range. Default c(25,75).

Value

A list of ggplot2 objects with the following for each station provided:

Annual_Normal_Days_Year: a plot that contains the above, below, and normal colour daily flow points

Examples

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

# Plot the year 2000 and change the flow timing percent totals        
plot_annual_flow_timing_year(station_number = "08NM116",
                             percent_total = 50,
                             year_to_plot = 2000)
                 
}
#> Warning: One or more calculations included missing values and NA's were produced. If desired, filter data for complete years or months, or use the 'ignore_missing' or 'allowed_missing' arguments (if applicable) to ignore or allow some missing values.
#> $Annual_Flow_Timing_Year

#>

Arguments

Value

See also

Examples