yip: Years in Period

In hydroTSM: Time Series Management and Analysis for Hydrological Modelling

Years in Period

Description

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

Usage

yip(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 years within the given dates. -) nmbr => the number of years within the given dates.

Value

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

Author(s)

Mauricio Zambrano-Bigiarini, mzb.devel@gmail

See Also

dip, diy, mip

Examples

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

## Computing the number of years between 1961 and 1975, 
## by using "%d-%m-%Y" as date format   ##
yip("01-01-1961", "01-01-1975", date.fmt= "%d-%m-%Y", out.type = "nmbr")

hydroTSM documentation built on Nov. 4, 2024, 5:07 p.m.