install_tz: install_tz

View source: R/tzupdater.R

install_tzR Documentation

install_tz

Description

Download and compile a tz database from the IANA website and make it active as an option. In case the tz db exists already, do not download again.

Usage

install_tz(
  tgt_version = "2019c",
  zic_path = NA,
  target_folder = paste0(tempdir(), "/tzupdater/data/IANA_release"),
  show_zic_log = FALSE,
  err_stop = TRUE,
  activate_tz = TRUE,
  verbose = TRUE,
  fail_if_zic_missing = FALSE
)

Arguments

tgt_version

Version to download and compile (eg 2019c, 2019a).

zic_path

Optional for Windows: path to the zic compiler (if not in C:\Cygwin\usr\sbin)

target_folder

Optional target folder. Default will be tzupdater/data/IANA_release as in tempdir()

show_zic_log

Optional: show logs from the zic compiler (TRUE/FALSE). Default FALSE.

err_stop

Stop on error (TRUE/FALSE). Default TRUE. Recommanded to TRUE.

activate_tz

Activate the tz database once installed. Default TRUE.

verbose

Print additional information to the console TRUE/FALSE. Default TRUE.

fail_if_zic_missing

Stop execution if zic is missing (default FALSE, will only display a message)

Examples

# Install tz database 2019c
install_tz("2019c")


tzupdater documentation built on Nov. 12, 2023, 5:06 p.m.