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 linters and fix linting issues #78

Merged
merged 23 commits into from
Jan 4, 2024
Merged

Add linters and fix linting issues #78

merged 23 commits into from
Jan 4, 2024

Conversation

RasmusSkytte
Copy link
Contributor

@RasmusSkytte RasmusSkytte commented Dec 18, 2023

Intent

This PR adds the linters developed for diseasystore and creates a new linter that checks for correct formatting of @param and @field roxygen tags.

Approach

The functions from diseasystore were copied over.

The linter for @param and @field tags looks for lines with these, and ensures they contain back ticks ` and carriage returns.
This is the proxy used to check it adheres to the MLR3 documentation templates.

Finally, the lints the new linters finds are resolved

Known issues

Lintr fails for quick-start.Rmd. This is due to the vignette not being written yet and is outside the scope of this PR.

Document workflow fails currently, but this is being fixed elsewhere (AEF-DDF/)
Documentation is updated -- the workflow fails for other reasons.

Checklist

  • The PR passes all local unit tests
  • I have documented any new features introduced
  • If the PR adds a new feature, please add an entry in NEWS.md
  • A reviewer is assigned to this PR

@RasmusSkytte RasmusSkytte self-assigned this Dec 18, 2023
Copy link

codecov bot commented Dec 19, 2023

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (8517a83) 83.98% compared to head (cb9fdaa) 86.77%.
Report is 23 commits behind head on main.

Files Patch % Lines
R/DiseasyActivity.R 25.00% 9 Missing ⚠️
R/0_linters.R 96.20% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #78      +/-   ##
==========================================
+ Coverage   83.98%   86.77%   +2.79%     
==========================================
  Files           8        8              
  Lines         843      885      +42     
==========================================
+ Hits          708      768      +60     
+ Misses        135      117      -18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RasmusSkytte RasmusSkytte marked this pull request as ready for review December 19, 2023 13:33
@RasmusSkytte RasmusSkytte requested review from a team, kaare-gr and LasseEngboChr and removed request for a team December 19, 2023 13:34
@RasmusSkytte RasmusSkytte added this to the v0.1 milestone Dec 20, 2023
@RasmusSkytte RasmusSkytte marked this pull request as draft December 22, 2023 14:46
@RasmusSkytte RasmusSkytte marked this pull request as ready for review January 2, 2024 08:22
@RasmusSkytte RasmusSkytte mentioned this pull request Jan 4, 2024
5 tasks
@RasmusSkytte RasmusSkytte merged commit 504e48b into main Jan 4, 2024
18 of 19 checks passed
@RasmusSkytte RasmusSkytte deleted the linters branch January 4, 2024 11:28
RasmusSkytte added a commit that referenced this pull request Dec 16, 2024
Add linters and fix linting issues
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