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 central function to aid checking milestone folders #1146

Merged
merged 6 commits into from
Jun 10, 2024

Conversation

vincentvanhees
Copy link
Member

@vincentvanhees vincentvanhees commented Jun 5, 2024

Fixes #1144

Function checks:

  • Do milestone folder(s) exists as needed for current or preceding GGIR part(s). If not, it creates them.
  • Are folders empty, if yes then give error telling the user what part(s) need to be run first.

This is useful when running part X when part X - 1 has not been run yet, which always produced cryptic error messages.

We already had some of this functionality but ad-hoc in some of the parts. In this PR I am moving all this to a central function to ensure we systematically do this for parts 1 to 5. I am skipping this for part 6, because part 6 is a bit different as it depends on threshold combination specific input folders.

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 vincentvanhees marked this pull request as ready for review June 5, 2024 09:23
@jhmigueles
Copy link
Collaborator

Changes look good to me and they work as expected in my tests, thanks!

@vincentvanhees vincentvanhees merged commit a3d0cec into master Jun 10, 2024
7 checks passed
@vincentvanhees vincentvanhees deleted the issue1144_check_milestone_files branch June 10, 2024 16:48
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.

Inform user when trying to run part X when part X-1 output folder is empty.
2 participants