Skip to contents

Compute Sleep Metrics

Source: R/eeg-sleep.R
eegSleepMetrics.Rd

Calculates summary sleep architecture metrics from staged sleep data. Requires that eegSleepStage() has been run and results are stored in metadata(x)$sleep_stages.

Usage

eegSleepMetrics(x)

Arguments

x

A PhysioExperiment object with sleep staging results in metadata(x)$sleep_stages.

Value

A data.frame with columns:

metric

Character name of the sleep metric.

value

Numeric value of the metric.

unit

Character unit of measurement.

Metrics include:

  • total_sleep_time: Time in N1+N2+N3+REM (minutes)

  • sleep_efficiency: TST / total recording time * 100 (percent)

  • waso: Wake after sleep onset (minutes)

  • sleep_latency: Time to first non-Wake epoch (minutes)

  • rem_latency: Time from first sleep to first REM (minutes)

  • pct_N1: Percentage of TST in N1

  • pct_N2: Percentage of TST in N2

  • pct_N3: Percentage of TST in N3

  • pct_REM: Percentage of TST in REM

  • pct_W: Percentage of total time in Wake

References

Berry, R. B., et al. (2017). AASM Scoring Manual Updates for 2017. Journal of Clinical Sleep Medicine, 13(5), 665-666.

See also

eegSleepStage(), eegSpindleDetect(), eegKcomplexDetect(), eegSlowWaveDetect(), eegPlotHypnogram()

Examples

pe <- make_eeg_sleep(n_time = 150000, n_channels = 2, sr = 500)
stages <- eegSleepStage(pe, epoch_sec = 30)
S4Vectors::metadata(pe)$sleep_stages <- stages
metrics <- eegSleepMetrics(pe)
print(metrics)
#>              metric value    unit
#> 1  total_sleep_time   4.0 minutes
#> 2  sleep_efficiency  80.0 percent
#> 3              waso   0.5 minutes
#> 4     sleep_latency   0.5 minutes
#> 5       rem_latency   0.0 minutes
#> 6            pct_N1   0.0 percent
#> 7            pct_N2   0.0 percent
#> 8            pct_N3  62.5 percent
#> 9           pct_REM  37.5 percent
#> 10            pct_W  20.0 percent