CircaCP: Sleep and Circadian Metrics Estimation from Actigraphy Data

A generic sleep–wake cycle detection algorithm for analyzing unlabeled actigraphy data. The algorithm has been validated against event markers using data from the Multi-Ethnic Study of Atherosclerosis (MESA) Sleep study, and its methodological details are described in Chen and Sun (2024) <doi:10.1098/rsos.231468>. The package provides functions to estimate sleep metrics (e.g., sleep and wake onset times) and circadian rhythm metrics (e.g., mesor, phasor, interdaily stability, intradaily variability), as well as tools for screening actigraphy quality, fitting cosinor models, and performing parametric change point detection. The workflow can also be used to segment long actigraphy sequences into regularized structures for physical activity research.

Version: 0.1.2
Depends: R (≥ 3.5)
Imports: data.table, pracma, stats, tibble
Suggests: ggplot2, knitr, minpack.lm, rmarkdown, testthat (≥ 3.0.0)
Published: 2025-11-12
DOI: 10.32614/CRAN.package.CircaCP (may not be active yet)
Author: Shanshan Chen [aut, cre], Jonathon Jacobs [ctb]
Maintainer: Shanshan Chen <schen3 at vcu.edu>
License: GPL (≥ 3)
NeedsCompilation: no
CRAN checks: CircaCP results

Documentation:

Reference manual: CircaCP.html , CircaCP.pdf
Vignettes: CircaCP: Getting Started (Import → Screen → Sleep Detection → Metrics) (source, R code)

Downloads:

Package source: CircaCP_0.1.2.tar.gz
Windows binaries: r-devel: not available, r-release: not available, r-oldrel: not available
macOS binaries: r-release (arm64): CircaCP_0.1.2.tgz, r-oldrel (arm64): CircaCP_0.1.2.tgz, r-release (x86_64): CircaCP_0.1.2.tgz, r-oldrel (x86_64): CircaCP_0.1.2.tgz

Linking:

Please use the canonical form https://CRAN.R-project.org/package=CircaCP to link to this page.