sleep_detection

It first uses a 24 h cosinor fit (via <code>sleep_cos()</code>) and a chosen thresholding rule to
label each minute as sleep (<code>label.sw = 1</code>) or wake (<code>label.sw = 0</code>).
Reference: Shanshan Chen, and Xinxin Sun.Validating CircaCP:
a generic sleep–wake cycle detection algorithm for unlabelled actigraphy data.
Royal Society Open Science 11, no. 5 (2024): 231468.

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.

Shanshan Chen

CircaCP

Sleep and Circadian Metrics Estimation from Actigraphy Data

Jonathon Jacobs

sleep_detection function

<dl><dt>clean_df</dt>
<dd>Minute-level <code>data.frame</code> with at least <code>Activity</code>. Additional
columns are preserved.</dd>
<dt>thr</dt>
<dd>Numeric threshold in [0, 1] applied to a rescaled cosinor fit.</dd>
<dt>dist</dt>
<dd>Character method key (e.g., <code>"ZAG"</code>); interpreted by your rule set.</dd></dl>

Arguments

Estimate precise sleep_wake cycles using CircaCP algorithm — sleep_detection

<dl>

<dt>clean_df</dt>
<dd>Minute-level <code>data.frame</code> with at least <code>Activity</code>. Additional
columns are preserved.</dd>


<dt>thr</dt>
<dd>Numeric threshold in [0, 1] applied to a rescaled cosinor fit.</dd>


<dt>dist</dt>
<dd>Character method key (e.g., <code>"ZAG"</code>); interpreted by your rule set.</dd>

</dl>

sleep_detection: Estimate precise sleep_wake cycles using CircaCP algorithm

Description

Usage

Value

Arguments

See Also