get_counts {agcounts}

get_counts

Description

Main function to extract counts from the Actigraph GT3X Files.

Usage

get_counts(
  path,
  epoch,
  lfe_select = FALSE,
  write.file = FALSE,
  return.data = TRUE,
  verbose = FALSE,
  tz = "UTC",
  parser = c("pygt3x", "GGIR", "read.gt3x"),
  ...
)

Arguments

path

Full path name to the GT3X File

epoch

The epoch length for which the counts should be summed.

lfe_select

Apply the Actigraph Low Frequency Extension filter, Default: FALSE

write.file

Export a CSV file of the counts, Default: FALSE

return.data

Return the data frame to the R Global Environment, Default: TRUE

verbose

Print the progress of the Actigraph raw data conversion to counts, Default: FALSE.

tz

the desired timezone, Default: UTC

parser

The parser to use when reading in the data. Parser values include pygt3x, GGIR, and read.gt3x options.

...

arguments passed to fwrite

Details

Main function to extract counts from the Actigraph GT3X Files.

Value

Writes a CSV file if write.file is TRUE and returns a data.frame if return.data is TRUE

See Also

read.gt3x

Examples

 get_counts(
  path = system.file("extdata/example.gt3x", package = "agcounts"),
  epoch = 60, lfe_select = FALSE,
  write.file = FALSE, return.data = TRUE
  )