Package 'tzdb'

Title: Time Zone Database Information
Description: Provides an up-to-date copy of the Internet Assigned Numbers Authority (IANA) Time Zone Database. It is updated periodically to reflect changes made by political bodies to time zone boundaries, UTC offsets, and daylight saving time rules. Additionally, this package provides a C++ interface for working with the 'date' library. 'date' provides comprehensive support for working with dates and date-times, which this package exposes to make it easier for other R packages to utilize. Headers are provided for calendar specific calculations, along with a limited interface for time zone manipulations.
Authors: Davis Vaughan [aut, cre], Howard Hinnant [cph] (Author of the included date library), Posit Software, PBC [cph, fnd]
Maintainer: Davis Vaughan <[email protected]>
License: MIT + file LICENSE
Version: 0.4.0
Built: 2024-06-07 04:32:27 UTC
Source: https://github.com/r-lib/tzdb

Help Index


Initialize tzdb for usage in other packages

Description

tzdb_initialize() is intended to be called from a client package's .onLoad() as tzdb::tzdb_initialize() to ensure that the tzdb package has been loaded.

The function itself doesn't do anything. It is instead called for the side-effect of loading the tzdb package. This does two things:

  • The tzdb .onLoad() hook is run, which sets the path to the time zone database.

  • The callables in tzdb are registered, which allows them to be called from other packages.

Usage

tzdb_initialize()

Details

There are alternative ways to ensure that tzdb is loaded. A client package can alternatively import a function from tzdb into its package with the ⁠@importFrom⁠ tag, or can call requireNamespace("tzdb", quiet = TRUE) from its .onLoad().

Value

NULL, invisibly.

Examples

tzdb_initialize()

Time zone database names

Description

tzdb_names() returns the time zone names found in the database.

Usage

tzdb_names()

Value

A character vector of zone names.

Examples

tzdb_names()

Retrieve the path to the time zone database

Description

Retrieve the path to the time zone database

Usage

tzdb_path(type)

Arguments

type

⁠[character(1)]⁠

The type of time zone database to return the path for.

Currently only "text" is supported.

Value

A single string containing the path to the database.

Examples

tzdb_path("text")

Time zone database version

Description

tzdb_version() returns the version of the time zone database currently in use.

Usage

tzdb_version()

Value

A single string of the database version.

Examples

tzdb_version()