run_agd_job: Run a job that initiates an ActiGraph data processing...

View source: R/run-agd-job.R

run_agd_jobR Documentation

Run a job that initiates an ActiGraph data processing pipeline for a single participant.

Description

This function runs a job that processes ActiGraph data for a single participant by calling agd_worker$new()$run(). This function is used heavily by the agd R6 class.

Usage

run_agd_job(x)

Arguments

x

Required: a one-row tibble from an agd object jobs data structure.

Value

Returns the results list from an agd_worker object.

Examples

# Create meta data frame (external/non-statcan users)
meta <- data.frame(
  id = c("jane-canuck", "john-canuck"),
  age = c(10, 40),
  agd_lfe = c(
    system.file("extdata", "jane-canuck-lfe.agd", package = "chms"),
    system.file("extdata", "john-canuck-lfe.agd", package = "chms")
  ),
  agd_nml = c(
    system.file("extdata", "jane-canuck-nml.agd", package = "chms"),
    system.file("extdata", "john-canuck-nml.agd", package = "chms")
  ),
  start_date = c("2021-05-30", "2021-05-27"),
  epoch_length = c(15, 60)
)

# Initialize agd R6 class
agd_data <- agd$new(
  id = meta$id,
  age = meta$age,
  agd_lfe = meta$agd_lfe,
  agd_nml = meta$agd_nml,
  epoch_length = meta$epoch_length,
  day_max = 3,
  sleep_algo = "barreira",
  non_wear_algo = "barreira",
  start_date = meta$start_date,
  cpu_max = 2
)

# Run data processing pipeline (load, clean, classify and summarize data)
# on first participant in agd_data
lst <- run_agd_job(agd_data$jobs[1,])

chms documentation built on Oct. 17, 2026, 5:07 p.m.