fill_missing_dates: Fills data gaps of missing dates

Description Usage Arguments Value Examples

View source: R/fill_missing_dates.R

Description

Fills data gaps of missing dates of the data provided. Builds a continuous data set from the start date to the end date. Only missing dates are filled, columns not specified as dates or groups will be filled with NA. Will completely fill first and last years, unless specified using fill_end_years = FALSE.

Usage

1
2
3
4
5
6
7
8
9
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 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. Not required as of fasstr 0.3.3 as all other columns are filled with NA.

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. 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 where missing dates existed.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 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)
                   
}

Example output



fasstr documentation built on Dec. 11, 2021, 9:55 a.m.