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

Revise and expand circadian rhythm and fragmentation analyses based on recent publications #1219

Merged
merged 140 commits into from
Nov 8, 2024

Conversation

vincentvanhees
Copy link
Member

This PR revises and expands a variety of circadian rhythm and fragmentation measures as described by Danilevicz et al. 2024.

Note that this was all part of a previous PR draft that I closed PR #1028, see that PR for a more detailed description of the updates. The only new thing in the current PR is that I have updated the documentation.

Closes #955.

My plan is to merge this PR after the 3.1-5 release which is scheduled for next week on the 7th of November. In the meantime I may be making (minor) additional commits to this PR to improve the documentation or code clarity.

Checklist before merging:

  • Existing tests still work (check by running the test suite, e.g. from RStudio).
  • Added tests (if you added functionality) or fixed existing test (if you fixed a bug).
  • Clean code has been attempted, e.g. intuitive object names and no code redundancy.
  • Documentation updated:
    • Function documentation
    • Chapter vignettes for GitHub IO
    • Vignettes for CRAN
  • Corresponding issue tagged in PR message. If no issue exist, please create an issue and tag it.
  • Updated release notes in inst/NEWS.Rd with a user-readable summary. Please, include references to relevant issues or PR discussions.
  • Added your name to the contributors lists in the DESCRIPTION file, if you think you made a significant contribution.
  • GGIR parameters were added/removed. If yes, please also complete checklist below.

If NEW GGIR parameter(s) were added then these NEW parameter(s) are:

  • documented in man/GGIR.Rd
  • included with a default in R/load_params.R
  • included with value class check in R/check_params.R
  • included in table of vignettes/GGIRParameters.Rmd with references to the GGIR parts the parameter is used in.
  • mentioned in NEWS.Rd as NEW parameter

If GGIR parameter(s) were deprecated these parameter(s) are:

  • documented as deprecated in man/GGIR.Rd
  • removed from R/load_params.R
  • removed from R/check_params.R
  • removed from table in vignettes/GGIRParameters.Rmd
  • mentioned as deprecated parameter in NEWS.Rd
  • added to the list in R/extract_params.R with deprecated parameters such that these do not produce warnings when found in old config.csv files.

vincentvanhees and others added 30 commits February 2, 2024 14:44
Co-Authored-By: Victor Barreto Mesquita <54644227+victormesquita40@users.noreply.github.com>
Co-Authored-By: Ian Danilevicz <43249776+iandanilevicz@users.noreply.github.com>
Revise IV and IS calculation + integrate in both part2 and part6
This is part of addressing #1048 and complements PR #1049 but I am adding this in PR #1028 because of all the changes to part 6 in this PR.
Add fragmentation metrics to PR1028
@vincentvanhees vincentvanhees marked this pull request as ready for review November 8, 2024 15:20
@vincentvanhees vincentvanhees merged commit 801855d into master Nov 8, 2024
7 checks passed
@vincentvanhees
Copy link
Member Author

... merged because has extensively been tested by project partners and because this will for now only be a GitHub release in a couple of months it will be part of a CRAN release, so enough time to spot missed issues, if any.

@vincentvanhees vincentvanhees deleted the work839_955_1028_1129 branch November 8, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expand part 6 functionality with more Circadian rhythm and fragmentation indicators
1 participant