POSIXct: Date-time Constructor Functions

Description Usage Arguments Details Value See Also

View source: R/ti.R

Description

Functions to create objects of classes "POSIXlt" and "POSIXct" representing calendar dates and times.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
POSIXct(x, ...)
POSIXlt(x, ...)
## S3 method for class 'jul'
as.POSIXct(x, tz = "", ...)
## S3 method for class 'ti'
as.POSIXct(x, tz = "", offset = 1, ...)
## S3 method for class 'jul'
POSIXct(x, ...)
## S3 method for class 'numeric'
POSIXct(x, tz = "", origin, ...)
## S3 method for class 'ti'
POSIXct(x, offset = 1, ...)
## Default S3 method:
POSIXct(x, ...)
## S3 method for class 'jul'
POSIXlt(x, ...)
## S3 method for class 'ti'
POSIXlt(x, ...)
## Default S3 method:
POSIXlt(x, ...)

Arguments

x

An object to be converted.

tz

A timezone specification to be used for the conversion, if one is required. System-specific (see time zones), but "" is the current timezone, and "GMT" is UTC (Universal Time, Coordinated).

origin

a date-time object, or something which can be coerced by as.POSIXct(tz="GMT") to such an object.

offset

a number between 0 and 1 specifying where in the period represented by the ti object x the desired time falls. offset = 1 gives the first second of the period and offset = 1 the last second, offset = 0.5 the middle second, and so on.

...

other args passed to ISOdatetime (POSIXct.jul and POSIXct.ti), as.POSIXct or as.POSIXlt as appropriate. May include a tz argument as above.

Details

The default methods POSIXct.default and POSIXlt.default do nothing but call as.POSIXct and as.POSIXlt, respectively. The POSIXct.ti method can take an offset argument as explained above, and the POSIXct.jul method can handle jul objects with a fractional part. The ti and jul methods for POSIXlt just call the POSIXct constructor and then convert it's value to a POSIXlt object.

Value

as.POSIXct, POSIXct and POSIXlt return objects of the appropriate class. If tz was specified it will be reflected in the "tzone" attribute of the result.

See Also

as.POSIXct and link{as.POSIXlt} for the default conversion functions, and DateTimeClasses for details of the classes.


tis documentation built on Sept. 29, 2021, 1:06 a.m.