stri_timezone_info: Query a Given Time Zone

Description

Provides some basic information on a given time zone identifier.

Usage

stri_timezone_info(tz = NULL, locale = NULL, display_type = "long")

Arguments

tz

NULL or '' for default time zone, or a single string with time zone ID otherwise

locale

NULL or '' for default locale, or a single string with locale identifier

display_type

single string; one of 'short', 'long', 'generic_short', 'generic_long', 'gmt_short', 'gmt_long', 'common', 'generic_location'

Details

Used to fetch basic information on any supported time zone.

For more information on time zone representation in ICU, see stri_timezone_list.

Value

Returns a list with the following named components:

  1. ID (time zone identifier),

  2. Name (localized human-readable time zone name),

  3. Name.Daylight (localized human-readable time zone name when DST is used, if available),

  4. Name.Windows (Windows time zone ID, if available),

  5. RawOffset (raw GMT offset, in hours, before taking daylight savings into account), and

  6. UsesDaylightTime (states whether a time zone uses daylight savings time in the current Gregorian calendar year).

Author(s)

Marek Gagolewski and other contributors

Examples

stri_timezone_info()
## $ID
## [1] "Australia/Melbourne"
## 
## $Name
## [1] "Australian Eastern Standard Time"
## 
## $Name.Daylight
## [1] "Australian Eastern Daylight Time"
## 
## $Name.Windows
## [1] "AUS Eastern Standard Time"
## 
## $RawOffset
## [1] 10
## 
## $UsesDaylightTime
## [1] TRUE
stri_timezone_info(locale='sk_SK')
## $ID
## [1] "Australia/Melbourne"
## 
## $Name
## [1] "východoaustrálsky štandardný čas"
## 
## $Name.Daylight
## [1] "východoaustrálsky letný čas"
## 
## $Name.Windows
## [1] "AUS Eastern Standard Time"
## 
## $RawOffset
## [1] 10
## 
## $UsesDaylightTime
## [1] TRUE
sapply(c('short', 'long', 'generic_short', 'generic_long',
         'gmt_short', 'gmt_long', 'common', 'generic_location'),
  function(e) stri_timezone_info('Europe/London', display_type=e))
##                  short               long                 
## ID               "Europe/London"     "Europe/London"      
## Name             "GMT"               "Greenwich Mean Time"
## Name.Daylight    "GMT+1"             "British Summer Time"
## Name.Windows     "GMT Standard Time" "GMT Standard Time"  
## RawOffset        0                   0                    
## UsesDaylightTime TRUE                TRUE                 
##                  generic_short         generic_long         
## ID               "Europe/London"       "Europe/London"      
## Name             "United Kingdom Time" "United Kingdom Time"
## Name.Daylight    "United Kingdom Time" "United Kingdom Time"
## Name.Windows     "GMT Standard Time"   "GMT Standard Time"  
## RawOffset        0                     0                    
## UsesDaylightTime TRUE                  TRUE                 
##                  gmt_short           gmt_long            common             
## ID               "Europe/London"     "Europe/London"     "Europe/London"    
## Name             "+0000"             "GMT"               "GMT"              
## Name.Daylight    "+0100"             "GMT+01:00"         "GMT+1"            
## Name.Windows     "GMT Standard Time" "GMT Standard Time" "GMT Standard Time"
## RawOffset        0                   0                   0                  
## UsesDaylightTime TRUE                TRUE                TRUE               
##                  generic_location     
## ID               "Europe/London"      
## Name             "United Kingdom Time"
## Name.Daylight    "United Kingdom Time"
## Name.Windows     "GMT Standard Time"  
## RawOffset        0                    
## UsesDaylightTime TRUE