From 7dec50d0f9e726db3b1b90fc7286bf38d42f20a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20N=C3=BCst?= Date: Fri, 1 Nov 2024 16:19:28 +0100 Subject: [PATCH] fix broken links, closes #13 --- guide/bundle.md | 2 +- guide/community-workflow.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/guide/bundle.md b/guide/bundle.md index 1a34ba9..e90b0d9 100644 --- a/guide/bundle.md +++ b/guide/bundle.md @@ -31,4 +31,4 @@ R Markdown has some nice features that are helpful for writing a report. - Literate programming and code chunks (hidden, visible) with nice looking and mostly hastle free PDF output (using [tinytex](https://yihui.name/tinytex/)) - You can configure document metadata, e.g. the title or subtitle, anywhere in the document, so you can choose to configure them only in the `codecheck.yml`, see [this example](https://github.com/codecheckers/Piccolo-2020/blob/master/codecheck/piccolo2020-codecheck.Rmd) - The CODECHECK [assistant](https://github.com/codecheckers/assistant/) is an R package that streamlines report writing with R -- You can capture the metadata of the computing environment in an automatically generated [_colophon_](https://github.com/benmarwick/rrtools/blob/master/inst/templates/paper.Rmd#L105) or _"reproducibility receipt"_, see [this discussion on Twitter](https://twitter.com/MilesMcBain/status/1263272935197782016?s=09), using `sessionInfo()` or `devtools::session_info()`. +- You can capture the metadata of the computing environment in an automatically generated _colophon_ that lists installed packages and session information (using `sessionInfo()` or `devtools::session_info()`), see for example [this one](https://github.com/benmarwick/rrtools/blob/master/inst/templates/paper.qmd#L119) in the template in `rrtools` by Ben Marwick, or a _reproducibility receipt_, see [this code example](https://github.com/PredictiveEcology/pemisc/blob/cf1516ff3893a7ffbfe1ae6623c0350c47c3e1b2/R/reproducibilityReceipt.R#L20), which adds git repository information and information about external libraries to the session information diff --git a/guide/community-workflow.md b/guide/community-workflow.md index ff79eaf..d4f0374 100644 --- a/guide/community-workflow.md +++ b/guide/community-workflow.md @@ -106,7 +106,7 @@ In any case, the overall goal is to _leave the workflow repository in the same o Some further tips: -- A familiarity with `make` is helpful to provide an easy entrypoint and build up useful code snippets for your CODECHECKs, see [https://the-turing-way.netlify.com/make/make.html](https://the-turing-way.netlify.com/make/make.html) and [https://swcarpentry.github.io/make-novice/reference](https://swcarpentry.github.io/make-novice/reference) +- A familiarity with `make` is helpful to provide an easy entrypoint and build up useful code snippets for your CODECHECKs, see and ## CODECHECK steps