/
quarter.Rd
51 lines (47 loc) · 1.79 KB
/
quarter.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/accessors-quarter.r
\name{quarter}
\alias{quarter}
\alias{semester}
\title{Get the fiscal quarter and semester of a date-time}
\usage{
quarter(
x,
type = "quarter",
fiscal_start = 1,
with_year = identical(type, "year.quarter")
)
semester(x, with_year = FALSE)
}
\arguments{
\item{x}{a date-time object of class POSIXct, POSIXlt, Date, chron, yearmon, yearqtr,
zoo, zooreg, timeDate, xts, its, ti, jul, timeSeries, fts or anything else that can
be converted with as.POSIXlt}
\item{type}{the format to be returned for the quarter. Can be one one of "quarter" -
return numeric quarter (default), "year.quarter" return the ending year and quarter
as a number of the form year.quarter, "date_first" or "date_last" - return the date
at the quarter's start or end, "year_start/end" - return a full description of the
quarter as a string which includes the start and end of the year
(ex. "2020/21 Q1").}
\item{fiscal_start}{numeric indicating the starting month of a fiscal year.}
\item{with_year}{logical indicating whether or not to include the quarter or
semester's year (deprecated; use the \code{type} parameter instead).}
}
\value{
numeric or a vector of class POSIXct if \code{type} argument is \code{date_first} or
\code{date_last}. When \code{type} is \code{year.quarter} the year returned is the end year of the
financial year.
}
\description{
Quarters divide the year into fourths. Semesters divide the year into halfs.
}
\examples{
x <- ymd(c("2012-03-26", "2012-05-04", "2012-09-23", "2012-12-31"))
quarter(x)
quarter(x, type = "year.quarter")
quarter(x, type = "year.quarter", fiscal_start = 11)
quarter(x, type = "date_first", fiscal_start = 11)
quarter(x, type = "date_last", fiscal_start = 11)
semester(x)
semester(x, with_year = TRUE)
}