File: base-start.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 (99 lines) | stat: -rw-r--r-- 1,414 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
\name{start}


\alias{start}
\alias{end}

\alias{start.timeDate}
\alias{end.timeDate}

\alias{min.timeDate}
\alias{max.timeDate}

\alias{range.timeDate}


\title{Terminal Times and Range}


\description{
    
    Extracts the time the first or last 
    observation was taken, or computes the
    range.
    
}


\usage{
\method{start}{timeDate}(x, \dots)

\method{end}{timeDate}(x, \dots)

\method{min}{timeDate}(\dots, na.rm = FALSE)

\method{max}{timeDate}(\dots, na.rm = FALSE)

\method{range}{timeDate}(\dots, na.rm = FALSE)
}


\arguments{
  
    \item{x}{
        an object of class \code{timeDate}.
        }
    \item{\dots}{
        [start][end] - \cr
        not used, \cr
        [min][max] -
        'timeDates' objects.
        } 
    \item{na.rm}{
        not used.
        }
                
}


\details{

    Note, the series will be time ordered before the start or
    end time stamps are extracted. Sorting is done in the
    way that the first observation appears in time before the 
    last observation.
    
}


\value{
   
    returns an object of class \code{timeDate}.

}


\examples{  
## timeCalendar - 
   # Random Calendar Dates:
   tR = sample(timeCalendar())
   sort(tR)
   tR
    
## start | end  -
   start(tR)
   end(tR)
   
## The First and Last Time Stamp:
   tR[1]
   tR[length(tR)]
   rev(tR)[1]
   
## The Range:
   c(start(tR), end(tR))
   range(tR)
}


\keyword{chron}