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

Gh pages #1150

Merged
merged 5 commits into from
Jun 11, 2024
Merged

Gh pages #1150

merged 5 commits into from
Jun 11, 2024

Conversation

jhmigueles
Copy link
Collaborator

@jhmigueles jhmigueles commented Jun 10, 2024

Adds chapters 8 to 12 to the github pages.

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.

Rename chapter9_SleepFundamentalsSpt to chapter9_SleepFundamentalsGuiders
Rename chapter12_TimeUseAnalyses to chapter12_TimeUseAnalysis
Add table of contents item for additional chapter 13. Circadian Rhythm Analysis (to be written later this year)

Co-Authored-By: Jairo H Migueles <[email protected]>
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, I have just committed the following minor changes:

  • Renaming chapter9_SleepFundamentalsSpt to chapter9_SleepFundamentalsGuiders
    to be in line with new chapter title
  • Rename chapter12_TimeUseAnalyses to chapter12_TimeUseAnalysis in an attempt to be consistent with the use of analysis versus analyses.
  • Added placeholder for additional chapter "13. Circadian Rhythm Analysis" to be written later this year.

I just checked it locally and when checks pass I will merge this PR.

@vincentvanhees vincentvanhees merged commit 001043a into master Jun 11, 2024
7 checks passed
@vincentvanhees vincentvanhees deleted the ghPages branch June 14, 2024 06:08
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