From e99a902baf6eaf8e84cc1d27230ed4c6ff372cc6 Mon Sep 17 00:00:00 2001 From: Dave Slager Date: Mon, 22 Jul 2024 16:01:52 -0700 Subject: [PATCH 1/5] copy old 1.2.0 updates from GitHub release notes --- NEWS.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/NEWS.md b/NEWS.md index f9a6f3fb..99ba65ee 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,10 @@ +# VISCtemplates 1.2.0 + +* Update Fred Hutch logo in Word and PDF templates +* Fix continuous integration issues (GitHub actions) +* New GitHub action to auto-generate empty report template in Word and PDF (for verifying format with PRs) and associated template fixes +* Fix double section numbering issue in Word doc template +* Add visc_load_pdata and DataPackageR to Rmd template code # VISCtemplates 1.1.0 From 803a82ee1ff6ca6ecd6f0d97468341760f56655e Mon Sep 17 00:00:00 2001 From: Dave Slager Date: Mon, 22 Jul 2024 17:57:58 -0700 Subject: [PATCH 2/5] draft update NEWS items for 1.3.0 --- NEWS.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/NEWS.md b/NEWS.md index 99ba65ee..8670f53a 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,44 @@ +# VISCtemplates (development version) + +Bug Fixes +* Fix major bug that broke PDF knitting on pandoc >= 3.1.7 (#159) +* Fix bug that occurred when a report subdirectory did not already exist, and add unit test (#173) +* Fix `insert_break()` to actually create a page break (#188) + + Update documentation to instruct users to use `\newpage` instead in new code + +Improvements to Report Templates +* Update header logo for SCHARP/Fred Hutch branding compliance (#195) +* Update templates and documentation for using correct syntax for multiple citations (#191) +* Add section number to References section in PDF output (#176) + +Testing and Continuous Integration +* Create unit tests to test knit all report templates to PDF and Word (#168, #182, #186, #187, #192) + + Test locally via `devtools::test()`; files written to `testthat/_snaps` + + On pull requests, test reports are written to file snapshots on GitHub Actions +* Add GitHub Actions runner to test statsrv compatibility by matching its R and pandoc versions (#172) +* Add `interactive = FALSE` option to interactive functions to facilitate automated unit testing (#168) +* Speed up GitHub Action that renders skeleton.Rmd (#166) + + But then remove it entirely once superseded by more thorough test knitting (#178) + +Documentation and UI Improvements +* Fix bad URL in GitHub setup instructions (#185) +* Add guidance for where to install data packages (#154) +* Add friendly error message to visc_load_pdata() when data package is not installed (#152) + +Package Maintenance +* Adjust filenames in R/ and tests/ to follow best practices (#175, #179) +* Respect existing getOption('repos') instead of forcing CRAN installations (#163) +* Adjust dependencies in DESCRIPTION (#164) + +Kellie +* #189 - Kellie +* #190 - Kellie +* (#196 - Kellie, once merged) +* #160 - Kellie +* #153 - Kellie +* #144 - Kellie +* #143 - Kellie + # VISCtemplates 1.2.0 * Update Fred Hutch logo in Word and PDF templates From efbb26091dba6de751a8ed8028c35b1d2ec0188e Mon Sep 17 00:00:00 2001 From: Kellie MacPhee Date: Tue, 23 Jul 2024 10:47:16 -0700 Subject: [PATCH 3/5] explain kellie's PRs --- NEWS.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/NEWS.md b/NEWS.md index 8670f53a..80925abb 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,6 +2,7 @@ Bug Fixes * Fix major bug that broke PDF knitting on pandoc >= 3.1.7 (#159) +* Fix bug with latex packages (specifically etex's \reserveinserts command) that broke PDF knitting (#160) * Fix bug that occurred when a report subdirectory did not already exist, and add unit test (#173) * Fix `insert_break()` to actually create a page break (#188) + Update documentation to instruct users to use `\newpage` instead in new code @@ -10,6 +11,9 @@ Improvements to Report Templates * Update header logo for SCHARP/Fred Hutch branding compliance (#195) * Update templates and documentation for using correct syntax for multiple citations (#191) * Add section number to References section in PDF output (#176) +* Clarify expectations for Background section of report (#143) +* Fix BAMA positivity call definition (#144) +* Add Acknowledgments section to report templates (#153) Testing and Continuous Integration * Create unit tests to test knit all report templates to PDF and Word (#168, #182, #186, #187, #192) @@ -24,20 +28,14 @@ Documentation and UI Improvements * Fix bad URL in GitHub setup instructions (#185) * Add guidance for where to install data packages (#154) * Add friendly error message to visc_load_pdata() when data package is not installed (#152) +* Specify existence of NAb template in README and vignettes (#189) Package Maintenance * Adjust filenames in R/ and tests/ to follow best practices (#175, #179) * Respect existing getOption('repos') instead of forcing CRAN installations (#163) * Adjust dependencies in DESCRIPTION (#164) - -Kellie -* #189 - Kellie -* #190 - Kellie -* (#196 - Kellie, once merged) -* #160 - Kellie -* #153 - Kellie -* #144 - Kellie -* #143 - Kellie +* Update package authors and maintainer (#190) +* Clean up latex template code, removing commented-out code and reorganizing for better readability (#196) # VISCtemplates 1.2.0 From 0f308358681de5e917b9fb53e4da8496e4b4e1f1 Mon Sep 17 00:00:00 2001 From: Kellie MacPhee Date: Tue, 23 Jul 2024 10:57:07 -0700 Subject: [PATCH 4/5] Create pull_request_template.md --- .github/pull_request_template.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..fd708d1c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ + + +## Description + +Describe your changes in detail. + +Give a short background, and outline important questions or details for the reviewer. + +## Related Issues + +Provide links to any related GitHub issues. + +## Checklist + +- [ ] This PR includes unit tests +- [ ] I have updated NEWS.md to describe the proposed changes From ab868363fb9fa83d0b9068fd0a5051f7a91d7042 Mon Sep 17 00:00:00 2001 From: Kellie MacPhee Date: Tue, 23 Jul 2024 11:00:09 -0700 Subject: [PATCH 5/5] Add to PR checklist question about documenting functions --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fd708d1c..24f5565e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,4 +13,6 @@ Provide links to any related GitHub issues. ## Checklist - [ ] This PR includes unit tests +- [ ] This PR establishes a new function or updates parameters in an existing function + - [ ] The roxygen skeleton for this function has been updated using `devtools::document` - [ ] I have updated NEWS.md to describe the proposed changes