Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add nonparametric circadian rhythm analysis (NPCRA) functions #3

Open
danielvartan opened this issue Aug 15, 2021 · 0 comments
Open
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@danielvartan
Copy link
Owner

danielvartan commented Aug 15, 2021

Comments in English, Spanish, or Portuguese are welcome.
Comentarios en inglés, español o portugués son bienvenidos.
Comentários em inglês, espanhol ou português são bem-vindos.


Instructions

  • Create a branch called feature/npcra.
  • See all the references in the basic references section before starting the development.
  • The function must take an object of class tsibble (mandatory).
  • Create one function for each NPCRA parameter.
  • Create special functions that allows the user to set the interval windows (e.g., the user may want a M5, M12 function, not only a M10 function).
  • The functions must include all methods of calculation presented in ActStudio.
  • Add a vignette, with practical examples, explaining the features.
  • All exported functions must be fully documented.
  • All functions must be accompanied by unit tests (100% coverage).
  • References in the documentation must be formatted in accordance with the APA (American Psychological Association) manual.
  • When finished, crate a PR to the main branch. Don't forget to mention this issue when creating your PR.

Materials

Basic references

  • Gonçalves, B. S. B., Cavalcanti, P. R., Tavares, G. R., Campos, T. F., & Araujo, J. F. (2014). Nonparametric methods in actigraphy: an update. Sleep Science, 7(3), 158-164. https://doi.org/10.1016/j.slsci.2014.09.013
  • Gonçalves, B. S. B., Adamowicz, T., Louzada, F. M., Moreno, C. R., & Araujo, J. F. (2015). A fresh look at the use of nonparametric analysis in actimetry. Sleep Medicine Reviews, 20, 84-91. https://doi.org/10.1016/j.smrv.2014.06.002
  • Witting, W., Kwa, I. H., Eikelenboom, P., Mirmiran, M., & Swaab, D. F. (1990). Alterations in the circadian rest-activity rhythm in aging and Alzheimer's disease. Biological Psychiatry, 27(6), 563-572. https://doi.org/10.1016/0006-3223(90)90523-5

Other references

@danielvartan danielvartan added the enhancement New feature or request label Aug 15, 2021
@danielvartan danielvartan added this to the Version 0.0.1 milestone Aug 15, 2021
@danielvartan danielvartan pinned this issue Aug 15, 2021
@danielvartan danielvartan unpinned this issue Aug 15, 2021
@danielvartan danielvartan changed the title Add the Nonparametric Circadian Rhythm Analysis (NPCRA) functions Add Nonparametric Circadian Rhythm Analysis (NPCRA) functions Aug 15, 2021
@danielvartan danielvartan changed the title Add Nonparametric Circadian Rhythm Analysis (NPCRA) functions Add nonparametric circadian rhythm analysis (NPCRA) functions Mar 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants