`R/calc_annual_cumulative_stats.R`

`calc_annual_cumulative_stats.Rd`

Calculates annual and seasonal total flows, as volumetric discharge or water yields, from a daily streamflow data set. For water year and seasonal data, the year is identified by the year in which the year or season ends. Two-seasons and four-seasons per year are calculated, with each 6 and 3-month seasons starting with the first month of the year (Jan for calendar year, specified for water year). Each season is designated by the calendar or water year in which it occurs. Calculates statistics from all values from complete years, unless specified. Returns a tibble with statistics.

calc_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, months = 1:12, include_seasons = FALSE, transpose = 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. |

months | Numeric vector of months to include in analysis (e.g. |

include_seasons | Logical value indication whether to include seasonal yields or volumetric discharges. Default |

transpose | Logical value indicating whether to transpose rows and columns of results. Default |

A tibble data frame with the following columns, ending with '_Volume_m3' or '_Yield_mm' based on selection:

calendar or water year selected

annual (or selected months) total flow, in m3 or mm

first of two season total flows, in m3 or mm

second of two season total flows, in m3 or mm

first of four season total flows, in m3 or mm

second of four season total flows, in m3 or mm

third of four season total flows, in m3 or mm

fourth of four season total flows, in m3 or mm

# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat()) if (file.exists(tidyhydat::hy_downloaded_db())) { # Calculate annual total volumetric flow statistics calc_annual_cumulative_stats(station_number = "08NM116") # Calculate annual total yield statistics with default HYDAT basin area calc_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE) # Calculate annual total yield statistics with a custom basin area calc_annual_cumulative_stats(station_number = "08NM116", use_yield = TRUE, basin_area = 800) }#> 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.#> # A tibble: 69 x 3 #> STATION_NUMBER Year Total_Yield_mm #> <chr> <dbl> <dbl> #> 1 08NM116 1949 NA #> 2 08NM116 1950 NA #> 3 08NM116 1951 NA #> 4 08NM116 1952 NA #> 5 08NM116 1953 NA #> 6 08NM116 1954 NA #> 7 08NM116 1955 NA #> 8 08NM116 1956 NA #> 9 08NM116 1957 NA #> 10 08NM116 1958 NA #> # ... with 59 more rows