File: date_time_info.Rd

package info (click to toggle)
r-cran-clock 0.7.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,856 kB
  • sloc: cpp: 19,564; sh: 17; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,062 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/posixt.R
\name{date_time_info}
\alias{date_time_info}
\title{Info: date-time}
\usage{
date_time_info(x)
}
\arguments{
\item{x}{\verb{[POSIXct / POSIXlt]}

A date-time.}
}
\value{
A data frame of low level information.
}
\description{
\code{date_time_info()} retrieves a set of low-level information generally not
required for most date-time manipulations. It returns a data frame with the
same columns as \code{\link[=sys_time_info]{sys_time_info()}}, but the \code{begin} and \code{end} columns are
date-times with the same time zone as \code{x}, and the \code{offset} column is an
integer rather than a second based \link[=duration_seconds]{duration} column
since this is part of the high-level API.
}
\examples{
x <- date_time_build(
  2021, 03, 14, c(01, 03), c(59, 00), c(59, 00),
  zone = "America/New_York"
)

# x[1] is in EST, x[2] is in EDT
x

info <- date_time_info(x)
info

# `end` can be used to iterate through daylight saving time transitions
date_time_info(info$end)
}