File: base-summary.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 (57 lines) | stat: -rw-r--r-- 719 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
\name{summary-methods}


\title{Summary Method}


\alias{summary.timeDate}


\description{

    Summarizes details of a 'timeDate' object.
}


\usage{
\method{summary}{timeDate}(object, \dots)
}


\arguments{

    \item{object}{
        an object of class \code{timeDate}.
        }
    \item{\dots}{
        arguments passed to other methods.
        }

}


\value{

    returns a summary report of the details of a \code{timeDate}
    object. This includes the starting and end date, the number of
    dates the format and the financial center in use.
   
}


\note{

    This S3 method will become in the future a S4 method
    
}


\examples{
## summary -
   tC = timeCalendar()
   summary(tC)
}


\keyword{chron}