stri_timezone_info: Query a Given Time Zone

In stringi: Fast and Portable Character String Processing Facilities

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

See Also

The official online manual of stringi at https://stringi.gagolewski.com/

Gagolewski M., stringi: Fast and portable character string processing in R, Journal of Statistical Software 103(2), 2022, 1-59, \Sexpr[results=rd]{tools:::Rd_expr_doi("10.18637/jss.v103.i02")}

Other datetime: stri_datetime_add(), stri_datetime_create(), stri_datetime_fields(), stri_datetime_format(), stri_datetime_fstr(), stri_datetime_now(), stri_datetime_symbols(), stri_timezone_get(), stri_timezone_list()

Other timezone: stri_timezone_get(), stri_timezone_list()

Examples

stri_timezone_info()
stri_timezone_info(locale='sk_SK')
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))

stringi documentation built on May 29, 2024, 8:16 a.m.