File: base-round.Rd

package info (click to toggle)
r-cran-timedate 3012.100-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 2,592 kB
  • ctags: 4
  • sloc: makefile: 13
file content (62 lines) | stat: -rw-r--r-- 1,055 bytes parent folder | download | duplicates (6)
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
57
58
59
60
61
62
\name{round}


\alias{round}
\alias{trunc}

\alias{round.timeDate}
\alias{trunc.timeDate}


\title{Rounding and Truncating 'timeDate' Objects}


\description{
    
    Rounds and truncates objects of class 'timeDate'.  
       
}


\usage{
\method{round}{timeDate}(x, digits = c("days", "hours", "mins")) 

\method{trunc}{timeDate}(x, units = c("days", "hours", "mins"), \dots)     
}


\arguments{
  
    \item{digits, units}{
        a character string denoting the date/time units in which the 
        results are desired.
        }   
    \item{x}{
        an object of class \code{timeDate}.
        }  
    \item{\dots}{
        arguments passed to other methods.
        }
       
}


\value{
    
    The two functions \code{round} and \code{trunc} allow to round or to 
    truncate \code{timeDate} objects to the specified unit and return
    them as \code{timeDate} objects. - Note, ther is an inconsistency
    \code{round} uses \code{digits} as argument and not \code{units}. 

}


\examples{
## round - 

## truncate -
}


\keyword{chron}