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

Adding modify_source_note() function #2071

Merged
merged 3 commits into from
Nov 21, 2024
Merged

Adding modify_source_note() function #2071

merged 3 commits into from
Nov 21, 2024

Conversation

ddsjoberg
Copy link
Owner

@ddsjoberg ddsjoberg commented Nov 20, 2024

What changes are proposed in this pull request?

If there is an GitHub issue associated with this pull request, please provide link.
closes #1910

A few more details: Source notes have been a part of gtsummary for a long time, but there has never been a user-facing interface for adding them. In this PR, we add functions to add and remove source notes from a table. The way that source notes are saved has been updated to be more general (that is, so we can add more than a single source note). There may have been some advanced users who accessed the internals and added source notes, and if they had, this will be a breaking change.


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

  • PR branch has pulled the most recent updates from main branch.
  • 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
  • All GitHub Action workflows pass with a ✅

When the branch is ready to be merged into master:

  • Update NEWS.md with the changes from this pull request under the heading "# gtsummary (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".

Copy link
Collaborator

@ayogasekaram ayogasekaram left a comment

Choose a reason for hiding this comment

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

Looks great to me! Thank you @ddsjoberg

@ddsjoberg ddsjoberg merged commit ad4005f into main Nov 21, 2024
7 checks passed
@ddsjoberg ddsjoberg deleted the 1910-source_notes branch November 21, 2024 21:15
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.

Support for multiple source notes within gtsummary
2 participants