Package: zeitR 0.1.0

Lucas França

zeitR: Actigraphy Data Parsing and Analysis for R

Provides tools for importing, parsing, and analysing raw actigraphy data from wrist-worn devices. Implements a full sleep analysis pipeline — off-wrist detection, main sleep period detection, nap detection, and WASO computation — validated epoch-for-epoch against the Condor circadiaBase Python reference pipeline using ActTrust hardware. Also computes standard non-parametric circadian rhythm variables (interdaily stability, intradaily variability, relative amplitude, L5, M10). Device-specific parameter presets can be swapped to adapt the pipeline to other actigraph models. Designed to complement slumbR in the Circadia Lab ecosystem.

Authors:Lucas França [aut, cre], Mario Leocadio-Miguel [aut]

zeitR_0.1.0.tar.gz
zeitR_0.1.0.zip(r-4.7)zeitR_0.1.0.zip(r-4.6)zeitR_0.1.0.zip(r-4.5)
zeitR_0.1.0.tgz(r-4.6-any)zeitR_0.1.0.tgz(r-4.5-any)
zeitR_0.1.0.tar.gz(r-4.7-any)zeitR_0.1.0.tar.gz(r-4.6-any)
zeitR_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
zeitR/json (API)

# Install 'zeitR' in R:
install.packages('zeitR', repos = c('https://circadia-bio.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/circadia-bio/zeitr/issues

Pkgdown/docs site:https://zeitr.circadia-lab.uk

On CRAN:

Conda:

3.78 score 1 scripts 16 exports 24 dependencies

Last updated from:3a0d920bcd (on main). Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK387
source / vignettesOK263
linux-release-x86_64OK360
macos-release-arm64OK291
macos-oldrel-arm64OK314
windows-develOK358
windows-releaseOK284
windows-oldrelOK354
wasm-releaseOK159

Exports:acttrust_paramscheck_consistencycompute_npcracompute_wasodetect_naps_crespodetect_offwrist_bimodaldetect_sleep_crespolabel_statesprepare_actigraphyread_actigraphyread_actigraphy_dirread_acttrustrun_pipelinerun_pipeline_batchscore_epochs_cole_kripkestudy_summary

Dependencies:clicpp11dplyrgenericsgluelatticelifecyclelubridatemagrittrpillarpkgconfigpurrrR6rlangstringistringrtibbletidyrtidyselecttimechangeutf8vctrswithrzoo

Single-recording sleep analysis
1. Read the recording | 2. Run the full pipeline | 3. Nightly sleep statistics | Timestamp issues | 4. Actogram | 5. Circadian rhythm analysis (NPCRA) | Next steps
Rendered fromsleep-analysis.Rmdusingknitr::rmarkdown

Last update: 2026-06-23
Started: 2026-06-23

Getting started with zeitR
What is zeitR? | Installation | Reading a single recording | The $epochs tibble | The $metadata list | Running the full pipeline | Nightly sleep statistics | Timestamp issues | Running pipeline steps individually | Next steps
Rendered fromgetting-started.Rmdusingknitr::rmarkdown

Last update: 2026-06-20
Started: 2026-06-19

Non-parametric circadian rhythm analysis
Overview | The five variables | Interdaily stability (IS) | Intradaily variability (IV) | Relative amplitude (RA) | L5 and M10 | Computing NPCRA | Interpretation example | Customising window widths | Using raw data frames | Batch NPCRA across a study | References
Rendered fromnpcra.Rmdusingknitr::rmarkdown

Last update: 2026-06-20
Started: 2026-06-20

Study-level analysis
Overview | Reading a directory of files | Participant-level summary | Column reference | Running the full pipeline across a study | Combining NPCRA and sleep statistics | Tips | Further reading
Rendered fromstudy-analysis.Rmdusingknitr::rmarkdown

Last update: 2026-06-20
Started: 2026-06-20