Add ability to set significant figures for tables in report #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR introduces configurable significant-figure formatting for tables generated by sbr_tables(), adds supporting tests, and updates documentation.
- Add internal
signif_table()to applysignif()to all numeric columns. - Extend
sbr_tables()signature withsigfigandsigfig_override, including input validation and override logic. - Add tests for default and overridden sigfig behavior; update docs and examples.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/testthat/test-sigfig.R | New tests for signif_table() and sigfig_override |
| tests/testthat/results.Rmd | Updated test results metadata (timestamp and temp path) |
| man/sbr_tables.Rd | Document sigfig and sigfig_override arguments |
| man/sbr_string.Rd | Wrapped long \item{sub} description |
| man/sbr_set_report.Rd | Wrapped \item{rm}/ask descriptions |
| man/sbr_reset_report.Rd | Wrapped \item{rm}/ask descriptions |
| man/sbr_number.Rd | Wrapped \item{sub} description |
| man/sbr_knit_results.Rd | Wrapped \item{sub}/main descriptions |
| R/tables.R | Extend sbr_tables() with sigfig logic and validation |
| R/sigfig.R | Implement signif_table() |
| DESCRIPTION | Bump RoxygenNote |
Co-authored-by: Copilot <[email protected]>
Merge remote-tracking branch 'origin/main' into sigfig # Conflicts: # DESCRIPTION # tests/testthat/results.Rmd
joethorley
approved these changes
Jun 4, 2025
|
Looks great |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds two arguments to sbr_tables():
sigfigsets the overall sigfig for all tables (default 3)sigfig_overridecan be null or a named vector of the tables (and sigfig value) to change specific tablesinternal function
signif_table()does the sigfig for numeric columns only.note it formats the numbers to drop trailing zeros
in sbr_tables() I then reset the right-alignment for Kable if initially numeric
e.g.
sbr_tables(sigfig = 3, sigfig_override = c("ppc" = 2))Added tests for
signif_table()andsbr_tables()additional functionalitylooks like this after formatted
