View source: R/plot_flow_duration.R
plot_flow_duration  R Documentation 
Plots flow duration curves of flow data from a daily streamflow data set. Plots the percent time flows are
equalled or exceeded. Calculates statistics from all values, unless specified. Data calculated using
calc_longterm_stats()
function then converted for plotting. Returns a list of plots.
plot_flow_duration(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
roll_days = 1,
roll_align = "right",
water_year_start = 1,
start_year,
end_year,
exclude_years,
custom_months,
custom_months_label,
complete_years = FALSE,
ignore_missing = FALSE,
months = 1:12,
include_longterm = TRUE,
log_discharge = TRUE,
log_ticks = ifelse(log_discharge, TRUE, FALSE),
include_title = 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. 
roll_days 
Numeric value of the number of days to apply a rolling mean. Default 
roll_align 
Character string identifying the direction of the rolling mean from the specified date, either by the first
( 
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 
custom_months 
Numeric vector of months to combine to summarize (ex. 
custom_months_label 
Character string to label custom months. For example, if 
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

months 
Numeric vector of month curves to plot. 
include_longterm 
Logical value indicating whether to include longterm curve of all data. Default 
log_discharge 
Logical value to indicate plotting the discharge axis (Yaxis) on a logarithmic scale. Default 
log_ticks 
Logical value to indicate plotting logarithmic scale ticks when 
include_title 
Logical value to indicate adding the group/station number to the plot, if provided. Default 
A list of ggplot2 objects with the following for each station provided:
Flow_Duration 
a plot that contains flow duration curves for each month, longterm, and (option) customized months 
calc_longterm_daily_stats
## Not run:
# Working examples:
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Plot flow durations using a data frame and data argument with defaults
flow_data < tidyhydat::hy_daily_flows(station_number = "08NM116")
plot_flow_duration(data = flow_data,
start_year = 1980)
# Plot flow durations using station_number argument with defaults
plot_flow_duration(station_number = "08NM116",
start_year = 1980)
# Plot flow durations and add custom stats for JulySeptember
plot_flow_duration(station_number = "08NM116",
start_year = 1980,
custom_months = 7:9,
custom_months_label = "Summer")
}
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.