`R/plot_annual_cumulative_stats.R`

`plot_annual_cumulative_stats.Rd`

Plots annual and seasonal (if `include_seaons = TRUE`

) total flows, volumetric discharge or water yields, from a
daily streamflow data set. Calculates statistics from all values, 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. Returns a list of plots.

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 )

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

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

use_yield | Logical value indicating whether to calculate area-based water yield, in mm, instead of volumetric discharge.
Default |

basin_area | Upstream drainage basin area, in square kilometres, to apply to observations. Three options: (1) Leave blank if (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 |

water_year_start | Numeric value indicating the month ( |

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 or volumetric discharges. Default |

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

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:

annual total volumetric discharge, in cubic metres

if include_seasons = TRUE, two seasons total volumetric discharges, in cubic metres

if include_seasons = TRUE, four seasons total volumetric discharges, in cubic metres

annual water yield, in millimetres

if include_seasons = TRUE, two seasons water yield, in millimetres

if include_seasons = TRUE, four seasons water yield, in millimetres

# 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) }#> Warning: One or more calculations included missing values and NA's were produced. Filter data for complete years or months, or use to ignore_missing = TRUE to ignore missing values.#> Warning: One or more calculations included missing values and NA's were produced. Filter data for complete years or months, or use to ignore_missing = TRUE to ignore missing values.#> Warning: One or more calculations included missing values and NA's were produced. Filter data for complete years or months, or use to ignore_missing = TRUE to ignore missing values.#> $Total_Yield#> #> $Two_Seasons_Yield#> #> $Four_Seasons_Yield#>