Understand any protected names in cardx::ard_*.survey.design() functions
#173
Assignees
Milestone
Comments
13 tasks
ddsjoberg
added a commit
that referenced
this issue
Jul 8, 2024
…182) **What changes are proposed in this pull request?** * Adding a check for variables named `variable` and `variable_level` in the `ard_categorical(by)` argument. **Reference GitHub issue associated with pull request.** _e.g., 'closes #<issue number>'_ Part of #173 -------------------------------------------------------------------------------- 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. - [ ] If a new `ard_*()` function was added, it passes the ARD structural checks from `cards::check_ard_structure()`. - [ ] If a new `ard_*()` function was added, `set_cli_abort_call()` has been set. - [ ] If a new `ard_*()` function was added and it depends on another package (such as, `broom`), `is_pkg_installed("broom", reference_pkg = "cardx")` has been set in the function call and the following added to the roxygen comments: `@examplesIf do.call(asNamespace("cardx")$is_pkg_installed, list(pkg = "broom"", reference_pkg = "cardx"))` - [ ] Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): `devtools::test_coverage()` Reviewer Checklist (if item does not apply, mark is as complete) - [ ] If a bug was fixed, a unit test was added. - [ ] 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 "`# cardx (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".
|
@ayogasekaram we can go ahead and close this one now, right? |
|
@ddsjoberg Yes this is good to go :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I think there are will be column names that don't work with
ard_categorical.survey.design()andard_continuous.survey.design(). We can probably do some work and program around these column names. But as a first step, let's understand which names are protected and add a check for those names, so we return a coherent error message to the users.Some potential names that will break these functions are:
valuenamevariablevariable_levelgroup1group1_levelbyany column name that matches one of the statistics returned, e.g.
n,mean, etc.@ayogasekaram can you take a look at this after we get the unit tests for
ard_categorical()done, theshow_column_headers()function done, and the gtsummary README?The text was updated successfully, but these errors were encountered: