summary.agd_worker: Summary method for the agd_worker R6 class.

View source: R/summary.agd_worker.R

summary.agd_workerR Documentation

Summary method for the agd_worker R6 class.

Description

This method renders summary tibbles for waking and sleeping hours from an agd_worker object to the console.

Usage

## S3 method for class 'agd_worker'
summary(object, ...)

Arguments

object

Required: an agd_worker object.

...

Optional: additional arguments affecting the summary produced. Note: currently not used.

Value

Returns NULL invisibly.

Examples

# Initialize agd_worker R6 class
agd_data <- agd_worker$new(
  id = "jane-canuck",
  age = 10,
  agd_lfe = system.file("extdata", "jane-canuck-lfe.agd", package = "chms"),
  agd_nml = system.file("extdata", "jane-canuck-nml.agd", package = "chms"),
  epoch_length = 15,
  day_max = 3,
  sleep_algo = "barreira",
  non_wear_algo = "barreira"
)

# Run data processing pipeline (load, clean, classify and summarize data)
agd_data$run()

# Summarize data
summary(agd_data)

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