read_gt3x: Read data from a gt3x file

Description Usage Arguments Details Value References Examples

View source: R/read_gt3x.R

Description

Read data from a gt3x file

Usage

1
2
3
4
read_gt3x(file, tz = "UTC", verbose = FALSE, include = c("METADATA",
  "PARAMETERS", "SENSOR_SCHEMA", "BATTERY", "EVENT", "TAG", "ACTIVITY",
  "HEART_RATE_BPM", "HEART_RATE_ANT", "HEART_RATE_BLE", "LUX", "CAPSENSE",
  "EPOCH", "EPOCH2", "EPOCH3", "EPOCH4", "ACTIVITY2", "SENSOR_DATA"))

Arguments

file

character. Path to the file

tz

character. The timezone to use

verbose

logical. Print updates to console?

include

character. The PACKET types to parse

Details

The default value for include gives all possible packet types, of which there are 18. Processing time can be reduced by passing a subset of the 18 possibilities. Exclusion is not recommended for the PARAMETERS and SENSOR_SCHEMA packets, which also do not take long to process.

Value

A list of processed data, with one element for each of the relevant packet types.

References

https://github.com/actigraph/GT3X-File-Format

Examples

1
2
3
4
5
file_3x <- system.file(
  "extdata", "example.gt3x", package = "AGread"
)
AG_3x <- read_gt3x(file_3x)
head(lapply(AG_3x, head))

AGread documentation built on Feb. 26, 2020, 5:12 p.m.