timznlst: Time Zone List
In splusTimeDate: Times and Dates from S-PLUS

timeZoneList

R Documentation

Time Zone List

Description

Returns or modifies the time zone list.

Usage

timeZoneList(...)

Arguments

...

(see below)

Details

The time zone list is a named list whose names are the character strings that are recognized when you convert strings to time objects, and whose elements are the corresponding time zone objects. (See the documentation for class timeZone.) The timeZoneList function provides an easy way for the user to define the character strings to use for input of given time zones, and to define user-defined time zones for use in timeDate objects. For example, a North American user would probably want to recognize "EST" as the US or Canadian time zone known as Eastern Standard Time, whereas an Australian user might prefer to have "EST" refer to Eastern Australian time. The timeZoneList function has the following behavior:

If no arguments are given, the current time zone list is returned.
If a single list is given as the argument, its named components are added to the time zone list.
If multiple named arguments are given, they are added to the list.

In either of the two latter cases, the elements to be added to the list must be time zone objects. The default time zone list has the following built-in zone components. (See documentation on the timeZone class for more information.)

Atlantic: can/atlantic (Standard/daylight Canadian Atlantic time)
ADT: can/atlantic
AST: can/atlantic
Halifax: can/atlantic
PuertoRico: st/atlantic (Atlantic Standard Time, Puerto Rico and Virgin Islands)
Eastern: us/eastern (Standard/daylight US Eastern time)
EST: us/eastern
EDT: us/eastern
EST5EDT: us/eastern
EST/EDT: us/eastern
Indiana: st/eastern (Standard only US/Canadian Eastern time)
Toronto: can/eastern (Standard/daylight Canadian Eastern time)
Central: us/central (Standard/daylight US Central time)
CST: us/central
CDT: us/central
CST6CDT: us/central
CST/CDT: us/central
Chicago: us/central
Winnipeg: can/central (Standard/daylight Canadian Central time)
Mountain: us/mountain (Standard/daylight US Mountain time)
MST: us/mountain
MDT: us/mountain
MST7MDT: us/mountain
MST/MDT: us/mountain
Denver: us/mountain
Arizona: st/mountain (Standard only US/Canadian Mountain time)
Edmonton: can/mountain (Standard/daylight Canadian Mountain time)
Pacific: us/pacific (Standard/daylight US Pacific time)
PST: us/pacific
PDT: us/pacific
PST8PDT: us/pacific
PST/PDT: us/pacific
Vancouver: can/pacific (Standard/daylight Canadian Pacific time)
Alaska: us/alaska (Standard/daylight US Alaska time)
AKST: us/alaska
AKDT: us/alaska
AKST/AKDT: us/alaska
Aleutian: us/hawaii (Standard/daylight US Hawaii/Aleutian time)
HST: st/hawaii (Standard only US Hawaii/Aleutian time)
Hawaii: st/hawaii
Midway: st/samoa (Standard time for Samoa)
Samoa: st/samoa
SST: st/samoa
Japan: st/japan (Standard time for Japan)
Tokyo: st/japan
JST: st/japan
China: st/china (Standard time for China and Western Australia)
HongKong: hongkong (Standard/daylight time for Hong Kong)
Singapore: singapore (Standard time for Singapore, reflecting changed zones in 1982)
Sydney: aust/nsw (Standard/summer time for New South Wales, Australia)
Hobart: aust/tasmania (Standard/summer time for Tasmania, Australia)
Melbourne: aust/victoria (Standard/summer time for Victoria, Australia)
Adelaide: aust/south (Standard/summer time for South Australia)
Darwin: st/caustralia (Standard only time for Central Australia)
Perth: aust/western (Standard/daylight time for Western Australia)
Auckland: newzealand (Standard time for New Zealand)
NZST: newzealand
NZDT: newzealand
Marshall: st/newzealand (Marshall Islands Standard Time)
Wake: st/newzealand (Wake Islands Standard Time)
IDLE: st/newzealand (International Date Line East)
Chamorro: st/eaustralia (Chamorro Standard Time - Guam and Northern Mariana Islands)
ChST: st/eaustralia (Chamorro Standard Time - Guam and Northern Mariana Islands)
Yap: st/eaustralia (Yap Time)
YAPT: st/eaustralia (Yap Time)
Caroline: st/caroline (Line Islands Time - Caroline and other Line Islands)
LINT: st/caroline (Line Islands Time - Caroline and other Line Islands)
UTC: utc (Greenwich Mean Time/Universal Coordinated Time)
GMT: utc
GDT: britain (Standard time for Great Britain)
London: britain (Standard time for Great Britain)
BST: britain
WET: europe/west (Standard/summer time for EU members, Western zone)
Wes: europe/west (Standard/summer time for EU members, Western zone)
WEST: europe/west
WET/WEST: europe/west
WED: europe/west
WEDT: europe/west
CET: europe/central (Standard/summer time for EU members, Central zone)
CEST: europe/central
MET: europe/central
MEST: europe/central
MET/MEST: europe/central
EET: europe/east (Standard/summer time for EU members, Eastern zone)
EEST: europe/east
EET/EEST: europe/east

Value

returns the value of the time zone list before the function call is returned. If arguments are given, it is returned invisibly.

Side Effects

If arguments are given, they are used to modify the current value of .time.zone.list, which is assigned in the splusTimeDate package environment. It is like timeDateOptions, where if you want your entries to the time zone list to persist in subsequent sessions, you should use timeZoneList in .First.

Examples

# return the entire time zone list 
timeZoneList() 
# define the string "PDT8PST" to mean US Pacific time 
timeZoneList(PDT8PST = timeZoneC("us/pacific")) 
# define a time zone for a small island 1/2 hour east of GMT 
timeZoneList(small.island = timeZoneR(offset=1800))

splusTimeDate documentation built on July 7, 2022, 5:05 p.m.