hydroTSM: mip – R documentation

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

mip

Months in Period

Description

Given any starting and ending dates, it generates:
1) a vector of class 'Date' with all the months between the two dates (both of them included), OR
2) the amount of months between the two dates

Usage

mip(from, to, date.fmt = "%Y-%m-%d", out.type = "seq")

Arguments

`from`	Character indicating the starting date for creating the sequence. It has to be in the format indicated by `date.fmt`.
`to`	Character indicating the ending date for creating the sequence. It has to be in the format indicated by `date.fmt`.
`date.fmt`	Character indicating the format in which the dates are stored in `from` and `to`, e.g. `%Y-%m-%d`. See `format` in `as.Date`.
`out.type`	character indicating the type of result that is given by this function. Valid values are: -) `seq` : a vectorial sequence with all the months within the given year -) `nmbr`: the number of days in the vectorial sequence with all the months within the given year

Value

Depending on the value of out.type, it returns:
1) a vector of class Date with all the months between from and to (both of them included), OR
2) a single numeric value with the amount of months between the two dates.

Author(s)

Mauricio Zambrano-Bigiarini, mzb.devel@gmail

Examples

# Sequence of monthly dates between "1961-01-01" and "1961-12-31" ##
mip("1961-01-01", "1961-12-31")

## Computing the number of months between "1961-01-01" and "1965-06-30", 
## with the date format  "%d-%m-%Y" ##
mip("01-01-1961", "30-06-1965", date.fmt= "%d-%m-%Y", out.type = "nmbr")

hydroTSM

Time Series Management, Analysis and Interpolation for Hydrological Modelling

v0.6-0

GPL (>= 2)

Authors

Mauricio Zambrano-Bigiarini [aut, cre, cph] (<https://orcid.org/0000-0002-9536-643X>)

Initial release

mip