Releases: FredHutch/VISCtemplates
Releases · FredHutch/VISCtemplates
VISCtemplates 1.3.2
VISCtemplates 1.3.1
VISCtemplates 1.3.0
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
- Update documentation to instruct users to use
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 totestthat/_snaps
- On pull requests, test reports are written to file snapshots on GitHub Actions
- Test locally via
- 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)
Release 1.2.0
Summarize changes since 1.1.0 release.
- 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
Release 1.1.0
Improvements to use_visc_report()
:
- A new NAb assay template.
- This function reminds the user to use VISC's report naming convention.
Release 1.0.0
This release implements assay-specific report templates with the create_visc_report()
function. See the NEWS for more info.
Version 0.3.0
- New "empty" report template without the boilerplate PT report text.
- Go to
File > New File > Rmarkdown... > From Template
and select the "Empty Report" template. - Or use
template = "visc_empty"
argument inrmarkdown::draft()
. - See the updated vignette for more info.
- Go to
- Changes to
bibliography.bib
file.- Shortened file contains only citations used in VISC reports.
- A project-level
bibliography.bib
file is written to thedocs/
directory. Previously there was one file generated for each report.
- New Github PR text links to the documentation for writing and code review.
- Bug fixes:
- Footnote hyperlinks fixed:
Footnote text (^[MY_FOOTNOTE])
.
- Footnote hyperlinks fixed: