diff --git a/README.Rmd b/README.Rmd index 348bb82..fcc232a 100644 --- a/README.Rmd +++ b/README.Rmd @@ -63,7 +63,7 @@ sleep_data <- fetch_sleep_parametres(hypnogram_file = hypnogram_file, 6. Wake_percentage 7. N1_percentage 8. N2_percentage -9 N3_percentage +9. N3_percentage 10. R_percentage, 11. sleep_efficiency diff --git a/README.md b/README.md index 37a9bb7..797c2c4 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,10 @@ library(Kumbogram) 5. R\_duration 6. Wake\_percentage 7. N1\_percentage -8. N2\_percentage 9 N3\_percentage -9. R\_percentage, -10. sleep\_efficiency +8. N2\_percentage +9. N3\_percentage +10. R\_percentage, +11. sleep\_efficiency ### Onsets and total sleep time diff --git a/docs/index.html b/docs/index.html index 7a44fa4..b954191 100644 --- a/docs/index.html +++ b/docs/index.html @@ -115,7 +115,8 @@

Sleep stage durations,
  • R_duration
  • Wake_percentage
  • N1_percentage
    • -
  • N2_percentage 9 N3_percentage
    • +
  • N2_percentage
    • +
  • N3_percentage
  • R_percentage,
  • sleep_efficiency
    • diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index b0c62c6..8814bf5 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.6 pkgdown_sha: ~ articles: kumbo-vignette: kumbo-vignette.html -last_built: 2022-08-22T16:42Z +last_built: 2022-08-22T17:00Z urls: reference: https://rahulvenugopal.github.io/Kumbogram/reference article: https://rahulvenugopal.github.io/Kumbogram/articles diff --git a/docs/search.json b/docs/search.json index bf7da18..57ec8d3 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -[{"path":"https://rahulvenugopal.github.io/Kumbogram/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Rahul Venugopal. Author, maintainer.","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Venugopal R (2022). Kumbogram: Calculates Sleep Macro Architecture Parameters. https://github.com/rahulvenugopal/Kumbogram, https://rahulvenugopal.github.io/Kumbogram/.","code":"@Manual{, title = {Kumbogram: Calculates Sleep Macro Architecture Parameters}, author = {Rahul Venugopal}, year = {2022}, note = {https://github.com/rahulvenugopal/Kumbogram, https://rahulvenugopal.github.io/Kumbogram/}, }"},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"kumbogram-","dir":"","previous_headings":"","what":"Calculates Sleep Macro Architecture Parameters","title":"Calculates Sleep Macro Architecture Parameters","text":"goal Kumbogram spit sleep macro architecture parameters hypnogram file","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Calculates Sleep Macro Architecture Parameters","text":"can install development version Kumbogram GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"rahulvenugopal/Kumbogram\")"},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Calculates Sleep Macro Architecture Parameters","text":"basic example shows use function:","code":"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)"},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"kumbogram-package-has-many-useful-functions-to","dir":"","previous_headings":"Example","what":"Kumbogram package has many useful functions to:","title":"Calculates Sleep Macro Architecture Parameters","text":"Gather sleep architecture related parameters scored hypnogram file fetch_sleep_params functions extracts 32 sleep variables","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"sleep-stage-durations-percentages-and-efficiency","dir":"","previous_headings":"Example","what":"Sleep stage durations, percentages and efficiency","title":"Calculates Sleep Macro Architecture Parameters","text":"Wake_duration N1_duration N2_duration N3_duration R_duration Wake_percentage N1_percentage N2_percentage 9 N3_percentage R_percentage, sleep_efficiency","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"onsets-and-total-sleep-time","dir":"","previous_headings":"Example","what":"Onsets and total sleep time","title":"Calculates Sleep Macro Architecture Parameters","text":"Wake_onset N1_onset N2_onset N3_onset R_onset TST","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"longest-streak-of-each-sleep-stage-by-epochs-count","dir":"","previous_headings":"Example","what":"Longest streak of each sleep stage by epochs count","title":"Calculates Sleep Macro Architecture Parameters","text":"W_longest_streak N1_longest_streak N2_longest_streak N3_longest_streak R_longest_streak","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"longest-streak-of-each-sleep-stage-by-duration","dir":"","previous_headings":"Example","what":"Longest streak of each sleep stage by duration","title":"Calculates Sleep Macro Architecture Parameters","text":"W_mean_length_of_streak N1_mean_length_of_streak N2_mean_length_of_streak N3_mean_length_of_streak R_mean_length_of_streak W_median_length_of_streak N1_median_length_of_streak N2_median_length_of_streak N3_median_length_of_streak R_median_length_of_streak","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 Kumbogram authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate sleep micro architecture parameters — fetch_sleep_params","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"Calculate sleep micro architecture parameters","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"","code":"fetch_sleep_params(hypnogram_file, epoch_duration)"},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"hypnogram_file character array sleep stages epoch_duration Duration sleep epoch seconds","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"data frame 32 columns","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"","code":"sleep_data <- fetch_sleep_params(hypnogram_file = c('W' ,'W','N1','N2','N2','N3','R'), epoch_duration = 30)"}] +[{"path":"https://rahulvenugopal.github.io/Kumbogram/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Rahul Venugopal. Author, maintainer.","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Venugopal R (2022). Kumbogram: Calculates Sleep Macro Architecture Parameters. https://github.com/rahulvenugopal/Kumbogram, https://rahulvenugopal.github.io/Kumbogram/.","code":"@Manual{, title = {Kumbogram: Calculates Sleep Macro Architecture Parameters}, author = {Rahul Venugopal}, year = {2022}, note = {https://github.com/rahulvenugopal/Kumbogram, https://rahulvenugopal.github.io/Kumbogram/}, }"},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"kumbogram-","dir":"","previous_headings":"","what":"Calculates Sleep Macro Architecture Parameters","title":"Calculates Sleep Macro Architecture Parameters","text":"goal Kumbogram spit sleep macro architecture parameters hypnogram file","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Calculates Sleep Macro Architecture Parameters","text":"can install development version Kumbogram GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"rahulvenugopal/Kumbogram\")"},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Calculates Sleep Macro Architecture Parameters","text":"basic example shows use function:","code":"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)"},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"kumbogram-package-has-many-useful-functions-to","dir":"","previous_headings":"Example","what":"Kumbogram package has many useful functions to:","title":"Calculates Sleep Macro Architecture Parameters","text":"Gather sleep architecture related parameters scored hypnogram file fetch_sleep_params functions extracts 32 sleep variables","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"sleep-stage-durations-percentages-and-efficiency","dir":"","previous_headings":"Example","what":"Sleep stage durations, percentages and efficiency","title":"Calculates Sleep Macro Architecture Parameters","text":"Wake_duration N1_duration N2_duration N3_duration R_duration Wake_percentage N1_percentage N2_percentage N3_percentage R_percentage, sleep_efficiency","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"onsets-and-total-sleep-time","dir":"","previous_headings":"Example","what":"Onsets and total sleep time","title":"Calculates Sleep Macro Architecture Parameters","text":"Wake_onset N1_onset N2_onset N3_onset R_onset TST","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"longest-streak-of-each-sleep-stage-by-epochs-count","dir":"","previous_headings":"Example","what":"Longest streak of each sleep stage by epochs count","title":"Calculates Sleep Macro Architecture Parameters","text":"W_longest_streak N1_longest_streak N2_longest_streak N3_longest_streak R_longest_streak","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/index.html","id":"longest-streak-of-each-sleep-stage-by-duration","dir":"","previous_headings":"Example","what":"Longest streak of each sleep stage by duration","title":"Calculates Sleep Macro Architecture Parameters","text":"W_mean_length_of_streak N1_mean_length_of_streak N2_mean_length_of_streak N3_mean_length_of_streak R_mean_length_of_streak W_median_length_of_streak N1_median_length_of_streak N2_median_length_of_streak N3_median_length_of_streak R_median_length_of_streak","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 Kumbogram authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate sleep micro architecture parameters — fetch_sleep_params","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"Calculate sleep micro architecture parameters","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"","code":"fetch_sleep_params(hypnogram_file, epoch_duration)"},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"hypnogram_file character array sleep stages epoch_duration Duration sleep epoch seconds","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"data frame 32 columns","code":""},{"path":"https://rahulvenugopal.github.io/Kumbogram/reference/fetch_sleep_params.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate sleep micro architecture parameters — fetch_sleep_params","text":"","code":"sleep_data <- fetch_sleep_params(hypnogram_file = c('W' ,'W','N1','N2','N2','N3','R'), epoch_duration = 30)"}]