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

Sleep minor revisions #1242

Merged
merged 17 commits into from
Dec 18, 2024
Merged

Sleep minor revisions #1242

merged 17 commits into from
Dec 18, 2024

Conversation

jhmigueles
Copy link
Collaborator

@jhmigueles jhmigueles commented Dec 11, 2024

This contains some minor revisions of code related to the detection of the sleep period time. These are the minor bugs I found while testing the HorAngle algorithm. There is no issue related, just let me know if you want me to create the issue for these.

  • Detection of daylight saving time days improved: I found that partial last days, those recording finishing between 11:00 and 11:59 were mistaken as daylight saving time days, and then the end of the SPT was shifted one hour.
  • Fraction_night_invalid is now re-calculated for the 6pm-6pm windows in the days classified as "daysleeper".

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.

Copy link
Member

@vincentvanhees vincentvanhees left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Jairo, please find my comments below. I am happy to help work on this, but maybe easier if you could first have a look at it.

R/g.sib.det.R Outdated Show resolved Hide resolved
R/g.sib.det.R Outdated Show resolved Hide resolved
NEWS.md Outdated Show resolved Hide resolved
NEWS.md Outdated Show resolved Hide resolved
NEWS.md Show resolved Hide resolved
@vincentvanhees vincentvanhees merged commit f120be0 into master Dec 18, 2024
8 checks passed
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.

2 participants