File: base-difftimeDate.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 (63 lines) | stat: -rw-r--r-- 1,051 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
63
\name{difftimeDate}


\title{Difference of two 'timeDate' Objects}


\alias{difftimeDate}


\description{
    
    Returns a difference of two 'timeDate' objects.
       
}


\usage{
difftimeDate(time1, time2, 
    units = c("auto", "secs", "mins", "hours", "days", "weeks"))  
}


\arguments{
  
    \item{time1, time2}{
        two objects objects of class \code{timeDate}.
        }
    \item{units}{
        a character string denoting the date/time units in which the 
        results are desired.
        }
       
}


\value{
    

    The function, \code{difftimeDate}, takes a difference of two 
    \code{timeDate} objects and returns an object of class \code{"difftime"} 
    with an attribute indicating the units.

}



\examples{
## Create Character Vectors:
   dts = c("1989-09-28", "2001-01-15", "2004-08-30", "1990-02-09")
   dts
   
## timeDate - 
   GMT = timeDate(dts, zone = "GMT", FinCenter = "GMT") 
   GMT

## diff - 
   # Suitably Lagged and Iterated Differences:
   difftimeDate(GMT[1:2], GMT[-(1:2)])  
}


\keyword{chron}