search

Gilead-BioStats / gsm

Good Statistical Monitoring R Package
https://gilead-biostats.github.io/gsm/
Apache License 2.0
36 stars 9 forks source link

QC: Update cookbook with new/working examples #1668

Closed lauramaxwell closed 1 month ago

lauramaxwell commented 1 month ago

QC Details

The Cookbook.Rmd is a series of examples taken from the inst/examples folder. To prevent having to constantly copy any edits, we will simply read the code in from the R scripts in that folder, like so (missing tick is intentional for formatting here):

``{r, code = readLines(system.file("examples/1_1_workflow_basic.R", package = "gsm")), eval = FALSE, include = TRUE}
``

This way, the only edits needed for the Cookbook.Rmd moving forward will be the addition/removal of example scripts, and the examples and Cookbook will remain in sync

Additional Comments

lauramaxwell commented 1 month ago

This issue depends on #1655 to be merged prior to completion