Plots means, medians, maximums, minimums, and percentiles for each month of all years of flow values
from a daily streamflow data set. Calculates statistics from all values, unless specified. Data calculated using the
`calc_monthly_stats()`

function. Produces a list containing a plot for each statistic. Returns a list of plots.

```
plot_monthly_stats(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
percentiles,
roll_days = 1,
roll_align = "right",
water_year_start = 1,
start_year,
end_year,
exclude_years,
months = 1:12,
complete_years = FALSE,
ignore_missing = FALSE,
allowed_missing = ifelse(ignore_missing, 100, 0),
log_discharge = FALSE,
log_ticks = ifelse(log_discharge, TRUE, FALSE),
scales_discharge = "fixed",
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

`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.- percentiles
Numeric vector of percentiles to calculate. Set to

`NA`

if none required. Default`NA`

.- roll_days
Numeric value of the number of days to apply a rolling mean. Default

`1`

.- roll_align
Character string identifying the direction of the rolling mean from the specified date, either by the first (

`'left'`

), last (`'right'`

), or middle (`'center'`

) day of the rolling n-day group of observations. Default`'right'`

.- 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`

).- complete_years
Logical values indicating whether to include only years with complete data in analysis. Default

`FALSE`

.- ignore_missing
Logical value indicating whether dates with missing values should be included in the calculation. If

`TRUE`

then a statistic will be calculated regardless of missing dates. If`FALSE`

then only those statistics from time periods with no missing dates will be returned. Default`FALSE`

.- allowed_missing
Numeric value between 0 and 100 indicating the

**percentage**of missing dates allowed to be included to calculate a statistic (0 to 100 percent). If`'ignore_missing = FALSE'`

then it defaults to`0`

(zero missing dates allowed), if`'ignore_missing = TRUE'`

then it defaults to`100`

(any missing dates allowed); consistent with`ignore_missing`

usage. Supersedes`ignore_missing`

when used.- 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`

.- scales_discharge
String, either 'fixed' (all y-axis scales the same) or 'free' (each plot has their own scale). Default

`'fixed'`

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

`FALSE`

.

A list of ggplot2 objects for each monthly statistic for each station provided that contain:

- Monthly Mean Flows
mean of all daily flows for a given month and year

- Monthly Median Flows
median of all daily flows for a given month and year

- Monthly Maximum Flows
maximum of all daily flows for a given month and year

- Monthly Minimum Flows
minimum of all daily flows for a given month and year

- Monthly P'n' Flows
(optional) each n-th percentile selected for a given month and year

```
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Plot monthly statistics using a data frame and data argument with defaults
flow_data <- tidyhydat::hy_daily_flows(station_number = "08NM116")
results <- plot_monthly_stats(data = flow_data,
start_year = 1980,
percentiles = 10)
# Plot monthly statistics for water years starting in October
results <- plot_monthly_stats(station_number = "08NM116",
start_year = 1980,
end_year = 2010,
water_year_start = 10,
percentiles = 10)
}
```