Skip to content

Commit

Permalink
Merge pull request #197 from FredHutch/news_1.3.0
Browse files Browse the repository at this point in the history
Update NEWS for 1.3.0 release
  • Loading branch information
slager authored Jul 23, 2024
2 parents 72087ad + ab86836 commit 09a0124
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Provide a general summary of your changes in the Title above. -->

## 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
- [ ] 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
46 changes: 46 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,49 @@
# VISCtemplates (development version)

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

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)
+ 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)
* 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)
* 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

* 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

Expand Down

0 comments on commit 09a0124

Please sign in to comment.