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

initial commit #1

Merged
merged 1 commit into from
Jul 27, 2023
Merged

initial commit #1

merged 1 commit into from
Jul 27, 2023

Conversation

ddsjoberg
Copy link
Collaborator

No description provided.

@ddsjoberg ddsjoberg enabled auto-merge (squash) July 27, 2023 04:45
@ddsjoberg ddsjoberg disabled auto-merge July 27, 2023 04:46
@ddsjoberg ddsjoberg merged commit 53df4a5 into main Jul 27, 2023
@ddsjoberg ddsjoberg deleted the initial-commits branch July 27, 2023 13:53
@ddsjoberg ddsjoberg mentioned this pull request Dec 15, 2023
11 tasks
ddsjoberg added a commit that referenced this pull request Dec 15, 2023
**What changes are proposed in this pull request?**
Added the `ard_dichotomous()` function.
Added a few more unit tests to improve coverage

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #79 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Dec 18, 2023
**What changes are proposed in this pull request?**
* Added `ard_hierarchical()` and `ard_hierarchical_count()`

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #54 


--------------------------------------------------------------------------------

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

- [x] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] Run `pkgdown::build_site()`. Check the R console for errors, and
review the rendered website.
- [x] Code coverage is suitable for any new functions/features:
`devtools::test_coverage()`
- [x] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
@bzkrouse bzkrouse mentioned this pull request Dec 18, 2023
11 tasks
@bzkrouse bzkrouse mentioned this pull request Dec 18, 2023
11 tasks
ddsjoberg added a commit that referenced this pull request Dec 20, 2023
**What changes are proposed in this pull request?**
* The `tbl_cross()` function now calculates percentages in three ways;
column, cell, and row.
* Restricted the `by` variable to be one column, so the percentages will
always make sense.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #56 


--------------------------------------------------------------------------------

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

- [x] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] Run `pkgdown::build_site()`. Check the R console for errors, and
review the rendered website.
- [x] Code coverage is suitable for any new functions/features:
`devtools::test_coverage()`
- [x] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Dec 22, 2023
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #63 


--------------------------------------------------------------------------------

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

- [x] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] Run `pkgdown::build_site()`. Check the R console for errors, and
review the rendered website.
- [x] Code coverage is suitable for any new functions/features:
`devtools::test_coverage()`
- [x] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".

---------

Co-authored-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
@ddsjoberg ddsjoberg mentioned this pull request Jan 3, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 3, 2024
**What changes are proposed in this pull request?**
@ddsjoberg I'm on the fence about this being 1 function or 2 (shuffle
and trim separately), but opted to make it just 1 function. Let me know
what you think!

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #62 


--------------------------------------------------------------------------------

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

- [x] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] Run `pkgdown::build_site()`. Check the R console for errors, and
review the rendered website.
- [x] Code coverage is suitable for any new functions/features:
`devtools::test_coverage()`
- [x] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".

---------

Co-authored-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
@ddsjoberg ddsjoberg mentioned this pull request Jan 4, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 4, 2024
**What changes are proposed in this pull request?**
Added `check_ard_structure()` to check ARD object structure.
Added the `"stat_label"` column to test ARD functions.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #92
closes #91


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
This was referenced Jan 4, 2024
ddsjoberg added a commit that referenced this pull request Jan 4, 2024
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #97 
closes #98 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 4, 2024
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
#96 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
@ddsjoberg ddsjoberg mentioned this pull request Jan 4, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 5, 2024
**What changes are proposed in this pull request?**
- The counting/tabulation code has been updated to use multivariable
`table()` instead of nested univariable calls to `table()`
- The `N` statistic is now returned for each level of the variable.
- The `ard_categorical(denominator)` argument is much more general now
and accepts a data frame (as before), an integer, one of `c("column",
"row", "cell")`, or a structured data frame.
- The `ard_crosstab()` function has been removed as `ard_categorical()`
easily handles this case now.
- The package now checks for protected column names, eg
`"...ard_xxxx..."`
- Rather than namespacing rlang, the package is now imported.
- The `categorical_variable_summary_fns()` and
`continuous_variable_summary_fns()` functions have been updated to
include an argument that allows users to supplement the default
statistics through this argument.
- `ard_categorical()` will now only return the statistics requested,
e.g. if a user only wants n and p, N will not be returned although it is
required to calculate p.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #90 
closes #88


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".

---------

Signed-off-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
Co-authored-by: Becca Krouse <14199771+bzkrouse@users.noreply.github.com>
ddsjoberg added a commit that referenced this pull request Jan 5, 2024
**What changes are proposed in this pull request?**
Adding `print.card()` method.

@bzkrouse what do you think of the print method? Once we finalize, I'll
finish the PR which will lead to some changes in snapshot testing I
think.

<img width="787" alt="image"
src="https://github.com/insightsengineering/cards/assets/26774684/a2b0f8d7-2142-4c81-9ff1-1a1a987cd104">

What the print method does:
- converts object to data frame so the list columns show the values
(unlike a tibble print)
- prints between 10 and 20 rows
- messaging for the number of rows/columns that are not shown
- Removes warning and error columns if nothing to report
- if there are more than 6 columns, statistic_fmt_fn/contex columns
removed
- A max of 9 characters are displayed for columns 'group##_level',
'variable_level', 'stat_label', and 'context'
- If a statistic is a double, then it is rounded to 3 decimal places
- If a proper function is found in the statistic_fmt_fn column, it's
printed as "\<fn\>" to save space

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #93


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
@ddsjoberg ddsjoberg mentioned this pull request Jan 7, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 8, 2024
**What changes are proposed in this pull request?**
- Added `ard_complex()` that can handle summaries similar to
`ard_continuous()`, but it not limited to univariable summaries. I
marked this function as experimental because I will need this function
to make `gtsummary::tbl_custom_summary()` work, and would prefer to
leave it marked as experimental until that integration is complete just
in case I need to update the function to make it fully compatible.
- Added lifecycle badges
- Renamed `max_values()` to `maximum_variable_values()`
- Documenting some un-exported functions that I had missed earlier

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #108
closes #103 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 10, 2024
**What changes are proposed in this pull request?**
* Adding functions that assist in checking whether a Suggested package
is installed. There are `rlang` functions that do this, but these
functions parse the DESCRIPTION file to get the minimum version required
(if present) and ensure both the package is installed AND an appropriate
version is available.

In the future, we will be implementing ARD functions that require other
packages to calculate the statistics. cards will serve as the basis for
an extension package

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
related #111 


--------------------------------------------------------------------------------

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

- [x] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] Run `pkgdown::build_site()`. Check the R console for errors, and
review the rendered website.
- [x] Code coverage is suitable for any new functions/features:
`devtools::test_coverage()`
- [x] `usethis::use_spell_check()` runs with no spelling errors in
documentation

When the branch is ready to be merged:
- [x] 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).
- [x] Increment the version number using `usethis::use_version(which =
"dev")`
- [x] Run `usethis::use_spell_check()` again
- [x] Approve Pull Request
- [x] Merge the PR. Please use "Squash and merge".

---------

Signed-off-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
Co-authored-by: Becca Krouse <14199771+bzkrouse@users.noreply.github.com>
@bzkrouse bzkrouse mentioned this pull request Jan 11, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 12, 2024
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #99 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
@ddsjoberg ddsjoberg mentioned this pull request Jan 12, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 12, 2024
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #39 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 18, 2024
**What changes are proposed in this pull request?**
- The `flatten_ard()` function has been removed from the package.
- The `label_cards()` function has been added that returns a basic
rounding/formatting function. The reason for the addition is to minimize
the size of the env saved with the rounding/formatting functions, which
was causing some wonkiness in some unit tests.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #105 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
@bzkrouse bzkrouse mentioned this pull request Jan 24, 2024
11 tasks
@ddsjoberg ddsjoberg mentioned this pull request Jan 25, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 25, 2024
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #125 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 25, 2024
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
Resolves #104 


--------------------------------------------------------------------------------

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

- [x] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] Run `pkgdown::build_site()`. Check the R console for errors, and
review the rendered website.
- [x] Code coverage is suitable for any new functions/features:
`devtools::test_coverage()`
- [x] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".

---------

Co-authored-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
ddsjoberg added a commit that referenced this pull request Jan 26, 2024
**What changes are proposed in this pull request?**
Adds the `print_ard_conditions()` function

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #118 

<img width="850" alt="image"
src="https://github.com/insightsengineering/cards/assets/26774684/bb62e550-734f-45a3-b149-8488ef3e3816">



--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".

---------

Signed-off-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
ddsjoberg added a commit that referenced this pull request Jan 27, 2024
**What changes are proposed in this pull request?**
- added a temporary hex sticker
- added the NEST pkgdown template

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
related #53 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
@ddsjoberg ddsjoberg mentioned this pull request Jan 27, 2024
11 tasks
ddsjoberg added a commit that referenced this pull request Jan 27, 2024
**What changes are proposed in this pull request?**


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_



--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 27, 2024
…134)

**What changes are proposed in this pull request?**
- using rlang::error_call() to get calling function name for messaging

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #128 
closes #133


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
This was referenced Jan 27, 2024
ddsjoberg added a commit that referenced this pull request Jan 30, 2024
**What changes are proposed in this pull request?**
- I started programming with this function in gtsummary, and it was
cumbersome to perform multi checks in one call to the function, and it
was more difficult to read. So I've updated the function to perform
checks on one named list at a time.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #124


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 30, 2024
**What changes are proposed in this pull request?**
* Made updates to the contributing guide and the PR template.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #135 

@bzkrouse is there anything else someone should know before contributing
to this project?


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 30, 2024
**What changes are proposed in this pull request?**
- Importing the standalone scripts using the standalone pkg. This will
help us keep consistency between cards and cardx as we continue
developing

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #126 


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Jan 31, 2024
**What changes are proposed in this pull request?**
- updated the API for the `all_ard_*()` selecting functions. Previously,
there were two arguments that accepted TRUE or FALSE indicating whether
you wanted the columns of variable names and the columns of variable
levels. The vast majority of the time you want both, which is the
default. But when you begin to need one or the other, you need to
specify two arguments and if you don't name them, it was unclear which
columns you're selecting. In this update, we now only have one argument
that accepts `c("variables", "levels")`. Now when you need to select one
or the other, it also makes it easier to read and know which columns are
being selected.

@bzkrouse do you think the values would be more clear named something
like `"varnames"` and `"varlevels"`, something else?

I think the updated code is easier to grok?

![image](https://github.com/insightsengineering/cards/assets/26774684/2f8abc40-2620-431d-aee7-f94b32b3d53e)


**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #123


--------------------------------------------------------------------------------

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

- [ ] Ensure all package dependencies are installed:
`devtools::install_dev_deps()`
- [ ] 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.
- [ ] 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()`
- [ ] `usethis::use_spell_check()` runs with no spelling errors in
documentation

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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge".
ddsjoberg added a commit that referenced this pull request Feb 1, 2024
**What changes are proposed in this pull request?**
* Style this entry in a way that can be copied directly into `NEWS.md`.
(#1, @ddsjoberg)

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
Resolves #106 


--------------------------------------------------------------------------------

Pre-review Checklist (if item does not apply, mark is as complete)
- [x] **All** GitHub Action workflows pass with a ✅
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] 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)

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

When the branch is ready to be merged:
- [x] 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).
- [x] Increment the version number using `usethis::use_version(which =
"dev")`
- [x] Run `usethis::use_spell_check()` again
- [x] Approve Pull Request
- [x] Merge the PR. Please use "Squash and merge" or "Rebase and merge".

---------

Co-authored-by: Daniel Sjoberg <danield.sjoberg@gmail.com>
ddsjoberg added a commit that referenced this pull request Feb 2, 2024
**What changes are proposed in this pull request?**
* Removed {broom} and {broom.helpers} package dependencies, along with
functions `ard_ttest()`, `ard_wilcoxtest()`, `ard_fishtest()`, and
`ard_chisqtest()`. These functions have been migrated to {cardx}.

**Reference GitHub issue associated with pull request.** _e.g., 'closes
#1'_
closes #143 

@bzkrouse these changes are mostly trivial, but a second pair of eyes on
the changes in unit testing would be beneficial.


--------------------------------------------------------------------------------

Pre-review Checklist (if item does not apply, mark is as complete)
- [x] **All** GitHub Action workflows pass with a ✅
- [x] PR branch has pulled the most recent updates from master branch:
`usethis::pr_merge_main()`
- [x] If a bug was fixed, a unit test was added.
- [x] Code coverage is suitable for any new functions/features
(generally, 100% coverage for new code): `devtools::test_coverage()`
- [x] 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).
- [ ] Increment the version number using `usethis::use_version(which =
"dev")`
- [ ] Run `usethis::use_spell_check()` again
- [ ] Approve Pull Request
- [ ] Merge the PR. Please use "Squash and merge" or "Rebase and merge".
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.

1 participant