summary-methods {timeDate} | R Documentation |
Summary method
Description
Summarizes details of a "timeDate"
object.
Usage
## S3 method for class 'timeDate'
summary(object, ...)
Arguments
object |
an object of class |
... |
arguments passed to other methods. |
Details
Creates a summary report of the details of a "timeDate"
object. This includes the starting and end date, the number of dates
the format and the financial center in use.
Value
Currently the function just prints the report and returns invisibly
the object.
TODO: The return value return value should not be relied upon
since it is inconsistent with the way other methods for summary
work. They create an object with a print method and returned the
object, which is typically printed but can also be assigned.
Examples
## summary -
tC = timeCalendar()
summary(tC)
[Package timeDate version 4022.108 Index]