File: timeDate-Calendar.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 (75 lines) | stat: -rw-r--r-- 1,538 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
\name{timeCalendar}


\title{'timeDate' from Calendar Atoms}


\alias{timeCalendar}


\description{

    Create a 'timeDate' object from calendar atoms.

}


\usage{
timeCalendar(y = getRmetricsOptions("currentYear"), m = 1:12, d = 1,
    h = 0, min = 0, s = 0,
    zone = "", FinCenter = "")
}


\arguments{

    \item{y, m, d}{
        calendar years (e.g. 1997), defaults are 1960,
        calendar months (1-12), defaults are 1, and
        calendar days (1-31), defaults are 1, \cr
        }
    \item{h, min, s}{
        hours of the days (0-23), defaults are 0,
        minutes of the days (0-59), defaults are 0, and
        seconds of the days (0-59), defaults are 0.
        }    
    \item{zone}{
        a character string, denoting the time zone or financial 
        center where the data were recorded.
        }
    \item{FinCenter}{
        a character with the the location of the
        financial center named as "continent/city".
        }

}


\value{

    returns a S4 object of \code{\link{class}} \code{"timeDate"}.

}


\examples{
## timeCalendar -
   
   # Current Year:
   getRmetricsOptions("currentYear")
   
   # 12 months of current year
   timeCalendar() 
   
   timeCalendar(m = c(9, 1, 8, 2), d = c(28, 15, 30, 9),
                y = c(1989, 2001, 2004, 1990), FinCenter = "GMT")
   
   timeCalendar(m = c(9, 1, 8, 2), d = c(28, 15, 30, 9),
                y = c(1989, 2001, 2004, 1990), FinCenter = "Europe/Zurich")
                
   timeCalendar(h = c(9, 14), min = c(15, 23))
}


\keyword{chron}