Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 2.26 KB

README.md

File metadata and controls

90 lines (66 loc) · 2.26 KB

Kumbogram

Kumbogram

The goal of Kumbogram is to spit out sleep macro architecture parameters from hypnogram file

Installation

You can install the development version of Kumbogram from GitHub with:

# install.packages("devtools")
devtools::install_github("rahulvenugopal/Kumbogram")

Example

This is a basic example which shows you how to use the function:

library(Kumbogram)
library(reader)
filename = 'data_full_6hrs_100Hz_hypno_30s.txt'
hypnogram_file <- n.readLines(paste(filename, sep = "\n"),
                              header = FALSE,
                              n=720)

sleep_data <- fetch_sleep_parametres(hypnogram_file = hypnogram_file,
                                     epoch_duration = 30)

Kumbogram package has many useful functions to:

  1. Gather sleep architecture related parameters from a scored hypnogram file

fetch_sleep_params functions extracts 32 sleep variables

Sleep stage durations, percentages and efficiency

  1. Wake_duration
  2. N1_duration
  3. N2_duration
  4. N3_duration
  5. R_duration
  6. Wake_percentage
  7. N1_percentage
  8. N2_percentage
  9. N3_percentage
  10. R_percentage,
  11. sleep_efficiency

Onsets and total sleep time

  1. Wake_onset
  2. N1_onset
  3. N2_onset
  4. N3_onset
  5. R_onset
  6. TST

Longest streak of each sleep stage by epochs count

  1. W_longest_streak
  2. N1_longest_streak
  3. N2_longest_streak
  4. N3_longest_streak
  5. R_longest_streak

Longest streak of each sleep stage by duration

  1. W_mean_length_of_streak
  2. N1_mean_length_of_streak
  3. N2_mean_length_of_streak
  4. N3_mean_length_of_streak
  5. R_mean_length_of_streak
  6. W_median_length_of_streak
  7. N1_median_length_of_streak
  8. N2_median_length_of_streak
  9. N3_median_length_of_streak
  10. R_median_length_of_streak