Skip to content

Releases: FredHutch/VISCtemplates

VISCtemplates 1.3.2

30 Jul 22:14
Compare
Choose a tag to compare

Bug Fix

  • Fix issue with insert_break() not inserting page breaks at times (#216)

Other improvements

  • Reconcile differences between empty report template and other report templates (#204)
  • Remove dependency on the full tidyverse, per best practices (#213)

VISCtemplates 1.3.1

24 Jul 17:24
Compare
Choose a tag to compare

Bug Fix

  • Re-flip Fred Hutch and SCHARP header logos to fix regression from #196, restoring intended logo positions in #195 (#205)

VISCtemplates 1.3.0

23 Jul 19:31
Compare
Choose a tag to compare

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)

Release 1.2.0

29 Apr 18:32
8001273
Compare
Choose a tag to compare

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

29 Apr 17:16
Compare
Choose a tag to compare

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

10 Jan 22:51
adcf124
Compare
Choose a tag to compare

This release implements assay-specific report templates with the create_visc_report() function. See the NEWS for more info.

Version 0.3.0

27 Oct 18:25
f2a5423
Compare
Choose a tag to compare
  • 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 in rmarkdown::draft().
    • See the updated vignette for more info.
  • Changes to bibliography.bib file.
    • Shortened file contains only citations used in VISC reports.
    • A project-level bibliography.bib file is written to the docs/ 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]).