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

Enhance test coverage for use_ad_template() #2605

Open
1 task
manciniedoardo opened this issue Dec 12, 2024 · 4 comments · May be fixed by #2615
Open
1 task

Enhance test coverage for use_ad_template() #2605

manciniedoardo opened this issue Dec 12, 2024 · 4 comments · May be fixed by #2615
Assignees
Labels

Comments

@manciniedoardo
Copy link
Collaborator

manciniedoardo commented Dec 12, 2024

Background Information

It would be great to get {admiral}'s test coverage to 100%. However, this should not come at the expense of development time/effort from {admiral} core developers. As such, I have made a set of issues tagged "Unit Tests" (such as this one for use_ad_template()) where users who wish to dip their feet into the {admiral} ecosystem can:

  • Learn a bit about unit testing for R packages
  • Make a meaningful contribution to {admiral}

by adding or modifying unit tests to account for lines not previously covered.

Important note: Given the above, this issue is for newcomers to {admiral} or users who wish to contribute to the package, and should not be taken on by core {admiral} developers.

Definition of Done

  • Unit test(s) added/modified to test the lines in red in use_ad_template():
    image
@manciniedoardo manciniedoardo changed the title General issue: Enhance test coverage for use_ad_template() and roxygen_param_by_vars() Enhance test coverage for use_ad_template() and roxygen_param_by_vars() Dec 12, 2024
@bms63
Copy link
Collaborator

bms63 commented Dec 12, 2024

Hey @manciniedoardo - I think we decided to move roxygen_param_by_vars() to admiraldev.

For use_ad_template() - I don't think we can write a test for it since it opens an interactive sessions, but I did find this https://github.com/r-lib/covr?tab=readme-ov-file#exclusion-comments - covr is the package used in the test report. @bundfussr

Can we close this issue please and open one for admiradev and a other issue for looking at using # nocov . Happy to create these

@manciniedoardo
Copy link
Collaborator Author

@bms63 sorry, you're right, I shouldn't have included roxygen_param_by_vars(). Maybe for this issue we could just add #nocov to the use_ad_template() line?

@bms63
Copy link
Collaborator

bms63 commented Dec 12, 2024

Sounds good to me!

@bms63
Copy link
Collaborator

bms63 commented Dec 12, 2024

Created issue for roxygen_param_by_vars() : pharmaverse/admiraldev#477

@manciniedoardo manciniedoardo changed the title Enhance test coverage for use_ad_template() and roxygen_param_by_vars() Enhance test coverage for use_ad_template() Dec 12, 2024
bms63 added a commit that referenced this issue Dec 23, 2024
@bms63 bms63 linked a pull request Dec 23, 2024 that will close this issue
15 tasks
@bms63 bms63 self-assigned this Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging a pull request may close this issue.

2 participants