localize_to_time_zone: Localize time zone values

In dschafer/activatr: Utilities for Parsing and Plotting Activities

Localize time zone values

Description

localize_to_time_zone uses Google Maps Time Zone APIs to localize the time zone in an act_tbl. This modifies a mutated act_tbl with the time column updated to contain the same absolute time, but with the appropriate time zone for where the activity took place.

Usage

localize_to_time_zone(df)

Arguments

df	An act_tbl object.

Details

Note that to avoid overuse of the APIs, this does an "approximation", in that it finds the correct time zone for the first point in the data frame, and assumes all points in that data frame use that time zone. Runs between time zones (or runs that cross daylight savings time shifts) will hence be recorded using a consistent, but not always pointwise correct, timezone.

Note that you must have previously called ggmap::register_google() to register an API key before calling this.

Value

That same act_tbl, but with the time column updated to be in the local time zone rather than UTC.

Examples

## Not run: 
example_gpx_file <- system.file(
  "extdata",
  "running_example.gpx.gz",
  package = "activatr"
)
act_tbl <- parse_gpx(example_gpx_file)
act_tbl_with_tz <- localize_to_time_zone(act_tbl)

## End(Not run)

dschafer/activatr documentation built on July 29, 2024, 3:18 a.m.