# ------------------------------------------------
# CITATION.cff file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# ------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "hypnoR" in publications use:'
type: software
license: MIT
title: 'hypnoR: Hypnogram Handling, Plotting, and Sleep Architecture Metrics'
version: 0.1.0
abstract: Provides a staging-agnostic layer for hypnogram ingestion, sleep architecture
  metric computation, cycle segmentation, and transition analysis. Accepts full AASM-staged
  hypnograms (W / N1 / N2 / N3 / REM) from mrpheus and coarser actigraphy-derived
  hypnograms (W / Sleep / Quiet sleep) from zeitR; all metric functions degrade gracefully
  depending on staging resolution. Includes publication-ready plotting via theme_circadia().
  Designed as the hypnogram layer of the Circadia Lab ecosystem, feeding into syncR::sync().
authors:
- family-names: França
  given-names: Lucas
  email: lucas.franca@northumbria.ac.uk
  orcid: https://orcid.org/0000-0003-0853-1319
- family-names: Leocadio-Miguel
  given-names: Mario
  email: mario.miguel@northumbria.ac.uk
  orcid: https://orcid.org/0000-0002-7248-3529
repository: https://circadia-bio.r-universe.dev
repository-code: https://github.com/circadia-bio/hypnoR
commit: 3b0e51c9cb495addbe8425c88ac85d06693e175c
url: https://hypnor.circadia-lab.uk
date-released: '2026-06-29'
contact:
- family-names: França
  given-names: Lucas
  email: lucas.franca@northumbria.ac.uk
  orcid: https://orcid.org/0000-0003-0853-1319