fasstr: fill_missing_dates – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

fill_missing_dates

Add rows of missing dates and fill missing flow values with NA

Description

Adds rows of dates with missing flow values to a streamflow data set with daily flow values of NA. Missing dates will be filled in gaps between data and completely fill the first and last years.

Usage

fill_missing_dates(
  data,
  dates = Date,
  values = Value,
  groups = STATION_NUMBER,
  station_number,
  water_year_start = 1,
  fill_end_years = TRUE
)

Arguments

`data`	Data frame of daily data that contains columns of dates, flow values, and (optional) groups (e.g. station numbers). Leave blank 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 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.
`water_year_start`	Numeric value indicating the month (`1` through `12`) of the start of water year for analysis. Default `1`.
`fill_end_years`	Logical value indicating whether to fill incomplete start and end years with rows of dates with NA flow values. If `FALSE` then only missing dates between the provided start and end dates will be filled. Default `TRUE`.

Value

A tibble data frame of the source data with additional rows of filled values of missing dates.

Examples

# Run if HYDAT database has been downloaded (using tidyhydat::download_hydat())
if (file.exists(tidyhydat::hy_downloaded_db())) {

# Fill missing dates with NA using calendar years
fill_missing_dates(station_number = "08NM116")

# Fill missing dates with NA using water years starting in August
fill_missing_dates(station_number = "08NM116", 
                   water_year_start = 8)
                   
}

fasstr

Analyze, Summarize, and Visualize Daily Streamflow Data

v0.3.2

Apache License 2.0

Authors

Jon Goetz [aut, cre] (<https://orcid.org/0000-0002-4993-1119>), Carl James Schwarz [aut], Robin Pike [ctb], Province of British Columbia [cph]

Initial release