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
52
53
54
55
56
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/calendar.R
\name{calendar_narrow}
\alias{calendar_narrow}
\title{Narrow a calendar to a less precise precision}
\usage{
calendar_narrow(x, precision)
}
\arguments{
\item{x}{\verb{[calendar]}
A calendar vector.}
\item{precision}{\verb{[character(1)]}
A precision. Allowed precisions are dependent on the calendar used.}
}
\value{
\code{x} narrowed to the supplied \code{precision}.
}
\description{
\code{calendar_narrow()} narrows \code{x} to the specified \code{precision}. It does so
by dropping components that represent a precision that is finer than
\code{precision}.
Each calendar has its own help page describing the precisions that you
can narrow to:
\itemize{
\item \link[=year-month-day-narrow]{year-month-day}
\item \link[=year-month-weekday-narrow]{year-month-weekday}
\item \link[=year-week-day-narrow]{year-week-day}
\item \link[=iso-year-week-day-narrow]{iso-year-week-day}
\item \link[=year-quarter-day-narrow]{year-quarter-day}
\item \link[=year-day-narrow]{year-day}
}
}
\details{
A subsecond precision \code{x} cannot be narrowed to another subsecond precision.
You cannot narrow from, say, \code{"nanosecond"} to \code{"millisecond"} precision.
clock operates under the philosophy that once you have set the subsecond
precision of a calendar, it is "locked in" at that precision. If you
expected this to use integer division to divide the nanoseconds by 1e6 to
get to millisecond precision, you probably want to convert to a time point
first, and use \code{\link[=time_point_floor]{time_point_floor()}}.
}
\examples{
# Hour precision
x <- year_month_day(2019, 1, 3, 4)
x
# Narrowed to day precision
calendar_narrow(x, "day")
# Or month precision
calendar_narrow(x, "month")
}
|
