Water-Month: Water Month
In HARPgroup/hydro-tools: Data processing and accessors for VAHydro

Water Month

R Documentation

Water Month

Description

Extract the month of the water year from a date or time object.

Usage

water.month(x, label = FALSE, abbr = TRUE)

Arguments

`x`	a date or time object or a numeric representing a calendar year month
`label`	logical TRUE will return an ordered factor for month with the month name as labels, FALSE will return a numeric
`abbr`	logical. FALSE will abbreviate the name of the month in the ordered factor.

Details

Extract the month of the water year from a date or time object. Can be returned as a number 1:12, for October through September respectively, or an ordered factor. A user may alternatively enter a calendar year month as a numeric to return the equivalent water year month

Value

If x is numeric, then returns a numeric. Otherwise, if label is TRUE, returns an ordered factor indicating the equivalent month of the water year. Otherwise, returns only the numeric that represents the month.