What is mrpheus? | Installation | Staging model | Reading a recording | Preparing a recording | Artefact detection | Spectral analysis | Band power | Spectrogram | Sleep event detection | Spindles | Slow oscillations | Automatic sleep staging | Exporting to hypnor | Full pipeline | References
Package: mrpheus 0.1.0
Lucas França
mrpheus: Polysomnography Signal Analysis for Sleep Research
Raw polysomnography (PSG) signal analysis for sleep and circadian research. Provides EDF/EDF+ ingestion, artefact detection, spectral analysis, sleep event detection (spindles, slow oscillations), automatic AASM sleep staging via a pre-trained LightGBM model (ported from YASA; Vallat & Walker, 2021), and respiratory and cardiac metrics. Exports staged hypnograms directly to hypnor and PSG-derived metrics to syncR. Part of the Circadia Lab R ecosystem.
Authors:
mrpheus_0.1.0.tar.gz
mrpheus_0.1.0.zip(r-4.7)mrpheus_0.1.0.zip(r-4.6)mrpheus_0.1.0.zip(r-4.5)
mrpheus_0.1.0.tgz(r-4.6-any)mrpheus_0.1.0.tgz(r-4.5-any)
mrpheus_0.1.0.tar.gz(r-4.7-any)mrpheus_0.1.0.tar.gz(r-4.6-any)
mrpheus_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
mrpheus/json (API)
| # Install 'mrpheus' in R: |
| install.packages('mrpheus', repos = c('https://circadia-bio.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/circadia-bio/mrpheus/issues
Pkgdown/docs site:https://mrpheus.circadia-lab.uk
Last updated from:4ca434630c (on main). Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 144 | ||
| source / vignettes | OK | 172 | ||
| linux-release-x86_64 | OK | 154 | ||
| macos-release-arm64 | OK | 159 | ||
| macos-oldrel-arm64 | OK | 159 | ||
| windows-devel | OK | 71 | ||
| windows-release | OK | 94 | ||
| windows-oldrel | OK | 76 | ||
| wasm-release | OK | 155 |
Exports:compute_ahicompute_band_powercompute_hrv_sleepcompute_odicompute_slow_oscillationscompute_spectrogramcompute_spindlesdetect_apneasdetect_artifactsexport_hypnogrampalette_orpheusprepare_psgread_edfstage_epochs
Dependencies:clidata.tabledplyredfReadergenericsgluegsignaljsonlitelatticelifecyclelightgbmmagrittrMatrixpillarpkgconfigpracmaR6Rcpprlangtibbletidyselectutf8vctrswithrzoo
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Compute Apnea-Hypopnea Index (AHI) | compute_ahi |
| Compute EEG band power per epoch | compute_band_power |
| Compute HRV metrics across sleep stages | compute_hrv_sleep |
| Compute Oxygen Desaturation Index (ODI) | compute_odi |
| Detect slow oscillations | compute_slow_oscillations |
| Compute a time-frequency spectrogram | compute_spectrogram |
| Detect sleep spindles | compute_spindles |
| Detect respiratory events (apneas and hypopneas) | detect_apneas |
| Detect artefact epochs in a PSG recording | detect_artifacts |
| Export a staged hypnogram for use with hypnor | export_hypnogram |
| Orpheus mosaic palette | palette_orpheus |
| Prepare a PSG recording for analysis | prepare_psg |
| Read an EDF or EDF+ recording | read_edf |
| Automatic AASM sleep staging | stage_epochs |
