File: trunc.times.Rd

package info (click to toggle)
chron 2.3-53-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 276 kB
  • sloc: ansic: 130; makefile: 2
file content (45 lines) | stat: -rw-r--r-- 1,238 bytes parent folder | download | duplicates (5)
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
\name{trunc.times}
\alias{round.times}
\alias{trunc.times}
\title{Truncate times Objects}
\description{
  Truncate times objects.
}
\usage{
\method{trunc}{times}(x, units = "days", eps = 1e-10, \dots)
}
\arguments{
  \item{x}{a \code{"times"} object.}
  \item{units}{Can be one of \code{"days"}, \code{"hours"}, 
    \code{"minutes"}, \code{"seconds"} or an unambiguous abbreviated
    version of any of those.}
  \item{eps}{Comparison tolerance.  Times are considered equal if their
    absolute difference is less than \code{eps}.}
  \item{\dots}{further arguments to be passed to or from methods.}
}
\details{
  The time is truncated to the second, minute, hour or day or to the
  value specified.

  There is also a \code{round} method which has the same arguments as
  the \code{trunc} method, and performs rounding instead of truncation.
}
\value{
  An object of class \code{"times"}.
}
\seealso{
  \code{\link{trunc}} for the generic function and default methods.
}
\examples{
tt <- times(c("12:13:14", "15:46:17"))
trunc(tt, "minutes")
trunc(tt, "min")
trunc(tt, times("00:01:00"))
trunc(tt, "00:01:00")
trunc(tt, 1/(24*60))

tt2 <- structure(c(3.0, 3.1, 3.5, 3.9), class = "times")
trunc(tt2, "day")
trunc(tt2)
}
\keyword{chron}