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

Check roxygen documentation #168

Merged
merged 38 commits into from
Feb 10, 2024
Merged

Check roxygen documentation #168

merged 38 commits into from
Feb 10, 2024

Conversation

edelarua
Copy link
Contributor

@edelarua edelarua commented Feb 10, 2024

What changes are proposed in this pull request?

  • Check all function documentation to ensure @return and @examples fields are present, no missing documentation pages, no typos, and consistent documentation of parameters. Also added function links where applicable.

This PR is pretty big - I can break it up if you prefer to review smaller pieces at a time!

Closes #149


Pre-review Checklist (if item does not apply, mark is as complete)

  • All GitHub Action workflows pass with a ✅
  • PR branch has pulled the most recent updates from master branch: usethis::pr_merge_main()
  • If a bug was fixed, a unit test was added.
  • Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): devtools::test_coverage()
  • Request a reviewer

Reviewer Checklist (if item does not apply, mark is as complete)

  • If a bug was fixed, a unit test was added.
  • Run pkgdown::build_site(). Check the R console for errors, and review the rendered website.
  • Code coverage is suitable for any new functions/features: devtools::test_coverage()

When the branch is ready to be merged:

  • Update NEWS.md with the changes from this pull request under the heading "# cards (development version)". If there is an issue associated with the pull request, reference it in parentheses at the end update (see NEWS.md for examples).
  • All GitHub Action workflows pass with a ✅
  • Approve Pull Request
  • Merge the PR. Please use "Squash and merge" or "Rebase and merge".

@edelarua edelarua added documentation Improvements or additions to documentation sme labels Feb 10, 2024
Copy link
Contributor

github-actions bot commented Feb 10, 2024

badge

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  ----------------------
R/apply_statistic_fmt_fn.R          58       2  96.55%   92, 166
R/ard_attributes.R                  28       0  100.00%
R/ard_categorical.R                304      15  95.07%   110, 205, 472-487, 523
R/ard_complex.R                     33       0  100.00%
R/ard_continuous.R                 178       4  97.75%   107, 197-198, 296
R/ard_dichotomous.R                 70       9  87.14%   48, 136-139, 141-144
R/ard_hierarchical.R                73       0  100.00%
R/ard_missing.R                     16       0  100.00%
R/as_nested_list.R                  41       1  97.56%   18
R/bind_ard.R                        21       1  95.24%   51
R/check_ard_structure.R             26       1  96.15%   24
R/check_pkg_installed.R            100       1  99.00%   157
R/default_stat_labels.R             18       0  100.00%
R/eval_capture_conditions.R         18       0  100.00%
R/get_ard_statistics.R              15       1  93.33%   73
R/import-standalone-stringr.R        1       0  100.00%
R/nest_for_ard.R                    69       1  98.55%   54
R/print_ard_conditions.R            72      65  9.72%    61-178
R/print.R                           69      10  85.51%   82, 91-99
R/process_selectors.R              102       0  100.00%
R/round5.R                           1       0  100.00%
R/selectors.R                       14       0  100.00%
R/shuffle_ard.R                    127       8  93.70%   202, 257, 261, 317-321
R/summary_functions.R               45       0  100.00%
R/tidy_ard_order.R                  23       0  100.00%
R/tidy_as_ard.R                     38      11  71.05%   86-96
R/utils.R                           15       0  100.00%
TOTAL                             1575     130  91.75%

Diff against main

Filename                 Stmts    Miss  Cover
---------------------  -------  ------  --------
R/process_selectors.R       +2       0  +100.00%
TOTAL                       +2       0  +0.01%

Results for commit: 2ce2d4f

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

github-actions bot commented Feb 10, 2024

Unit Tests Summary

  1 files  64 suites   10s ⏱️
 62 tests 36 ✅ 26 💤 0 ❌
124 runs  85 ✅ 39 💤 0 ❌

Results for commit 2ce2d4f.

♻️ This comment has been updated with latest results.

@ddsjoberg ddsjoberg self-requested a review February 10, 2024 17:59
@ddsjoberg ddsjoberg added the ARD label Feb 10, 2024
Copy link
Collaborator

@ddsjoberg ddsjoberg left a comment

Choose a reason for hiding this comment

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

Thank you for the incredibly thoughtful and thorough review!

@ddsjoberg ddsjoberg merged commit 70631a5 into main Feb 10, 2024
28 checks passed
@ddsjoberg ddsjoberg deleted the 149_roxygen_cleanup@main branch February 10, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARD documentation Improvements or additions to documentation sme
Projects
None yet
Development

Successfully merging this pull request may close these issues.

General roxygen consistency
2 participants