View source: R/add_cumulative_volume.R

add_cumulative_volume | R Documentation |

Add a column of rolling daily cumulative volumetric flows on an annual basis to a daily streamflow data set. Adds the volumetric discharge from each day with the previous day(s) for each year, in units of cubic metres. The cumulative flows restart every year and are only calculated in years with complete data.

```
add_cumulative_volume(
data,
dates = Date,
values = Value,
groups = STATION_NUMBER,
station_number,
water_year_start = 1,
months = 1:12
)
```

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

`water_year_start` |
Numeric value indicating the month ( |

`months` |
Numeric vector of months to add cumulative flows (e.g. |

A tibble data frame of the source data with an additional column:

`Cumul_Volume_m3` |
cumulative volumetric flows for each day for each year, in units of cubic metres |

```
# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {
# Add a column based on water years starting in August
add_cumulative_volume(station_number = "08NM116",
water_year_start = 8)
}
```

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.