File: base-format.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 (76 lines) | stat: -rw-r--r-- 998 bytes parent folder | download | duplicates (5)
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
\name{format-methods}


\title{Format Methods}


\alias{format}
\alias{format.timeDate}


\description{

    Formats 'timeDate' objects as ISO conform character strings.
}


\usage{
\method{format}{timeDate}(x, format = "", tz = "", usetz = FALSE, \dots)
}


\arguments{

    \item{format}{
        a character string describing the format.
        }
    \item{tz}{
        a timezone specification to be used for the conversion. 
        }    
    \item{usetz}{
        a logical.
        }   
    \item{x}{
        an object of class \code{timeDate}.
        }
    \item{\dots}{
        arguments passed to other methods.
        }

}


\value{

    returns an ISO conform formatted character string.
   
}


\note{

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


\seealso{

    \code{as.character}.

}
    

\examples{
## timeCalendar -
   # Time Calebdar 16:00
   tC = timeCalendar() + 16*3600
   tC
   
## Format as ISO Character String: 
   format(tC)
}


\keyword{chron}