get_hydro_years_seasons: Compute the hydrological year days and the seasons.

Description Usage Arguments Value

View source: R/utils.R

Description

Compute a data.frame containing the hydrological year, and optionnally the days of the hydrological year and the season which each day belongs to.

Usage

1
2
3
4
5
6
7
8
get_hydro_years_seasons(
  dates,
  month = 9,
  day_of_the_year = TRUE,
  seasons = list(SummerFall = 5:10, WinterSpring = c(11:12, 1:4)),
  seasons_by_day = FALSE,
  minimal = FALSE
)

Arguments

dates

Date vector. A date/time vector (will be coerced to date using as.Dates())

month

numeric. Month number (1->12) defining the start of a hydrological year

day_of_the_year

logical. should the days of the (hydrological) year be computed?

seasons

list. List defining the seasons in month number (1:12) (or days if 'seasons_by_day' is TRUE).

seasons_by_day

logical. are seasons defined by days (of the year)? in the seasons argument.

minimal

logical. Should only the minimal desired results be returned or intermediate results as well?

Value

a data.frame containing the hydrological year, and optionnally the days of the hydrological year and the season which each day belongs to.


IvanHeriver/hsa-R-package documentation built on Dec. 17, 2021, 11:32 p.m.