with_timezone: Time zone

In jimhester/withr: Run Code 'With' Temporarily Modified Global State

Time zone

Description

Change the time zone, and restore it afterwards.

Usage

with_timezone(tz, code)

local_timezone(tz, .local_envir = parent.frame())

Arguments

tz	⁠[character(1)]⁠ a valid time zone specification, note that time zone names might be platform dependent.
code	[any] Code to execute in the temporary environment
.local_envir	The environment to apply the change to.

Details

with_timezone() runs the code with the specified time zone and resets it afterwards.

local_timezone() changes the time zone for the caller execution environment.

Value

[any]
The results of the evaluation of the code argument.

See Also

withr for examples

Sys.timezone().

Examples

Sys.time()
with_timezone("Europe/Paris", print(Sys.time()))
with_timezone("America/Los_Angeles", print(Sys.time()))

fun1 <- function() {
  local_timezone("CET")
  print(Sys.time())
}

fun2 <- function() {
  local_timezone("America/Los_Angeles")
  print(Sys.time())
}
Sys.time()
fun1()
fun2()
Sys.time()

jimhester/withr documentation built on Feb. 4, 2024, 12:50 a.m.