File: calendar-julian.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 (92 lines) | stat: -rw-r--r-- 1,785 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
\name{julian}


\title{Julian Counts and Calendar Atoms}


\alias{julian,timeDate-method}

\alias{atoms}
\alias{atoms,ANY-method}
\alias{atoms,timeDate-method}

\alias{months,timeDate-method}


\description{
    
    Returns Julian day counts, date/time atoms from a 'timeDate' object, 
    and extracts month atoms from a 'timeDate' object.  
       
}


\usage{
\S4method{julian}{timeDate}(x, origin = timeDate("1970-01-01"), 
    units = c("auto", "secs", "mins", "hours", "days", "weeks"), 
    zone = NULL, FinCenter = NULL, \dots)

\S4method{atoms}{timeDate}(x, \dots)

\S4method{months}{timeDate}(x, abbreviate = NULL)
}


\arguments{
  
    \item{x}{
        an object of class \code{timeDate}.
        }
    \item{origin}{
        a length-one object inheriting from class \code{"timeDate"}
        setting the origin for the julian counter.
        }
    \item{units}{
        a character string denoting the date/time units in which the 
        results are desired.
        }
    \item{zone}{
        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". 
        }   
    \item{abbreviate}{
        currently not used.
        }   
    \item{\dots}{
        arguments passed to other methods.
        }
       
}


\value{
  
    \code{julian} 
    returns a \code{timeDate} object as a Julian count.
    
    \code{atoms} and \code{months}
    extrac from a \code{timeDate} object the calendar atoms, i.e.
    the year, month, day, and optionally hour, minute and second.
    
}



\examples{
## julian -
   tC = timeCalendar()
   julian(tC)[1:3]
   
## atoms -
   atoms(tC)
   
## months -
   months(tC)
}


\keyword{chron}