use_github_action

Creates a GitHub Actions workflow that runs
<code>isReproducible()</code> on all R Markdown files in the repository.
The workflow installs pandoc so that the documents can be rendered.
Depending on the result, a badge file <code>reproducibleRchunks-badge.svg</code> is generated
indicating successful, failing or unknown reproduction status.

Provide reproducible R chunks in R Markdown document that automatically check computational results for reproducibility. This is achieved by creating json files storing metadata about computational results. A comprehensive tutorial to the package is available as preprint by Brandmaier & Peikert (2024, <doi:10.31234/osf.io/3zjvf>).

Andreas M. Brandmaier 

reproducibleRchunks

Automated Reproducibility Checks for R Markdown Documents

Aaron Peikert 

use_github_action function

<dl><dt>files</dt>
<dd>Character. File(s) that should be tested for reproducibility. If NULL, all Rmd files in the directory.</dd>
<dt>path</dt>
<dd>Path to the workflow file to create.
Defaults to <code>.github/workflows/reproducibleR.yml</code>.</dd>
<dt>packages</dt>
<dd>Character. If NULL, necessary R packages are inferred automatically.</dd></dl>

Arguments

Add GitHub Action to test reproducibility — use_github_action

<dl>

<dt>files</dt>
<dd>Character. File(s) that should be tested for reproducibility. If NULL, all Rmd files in the directory.</dd>


<dt>path</dt>
<dd>Path to the workflow file to create.
Defaults to <code>.github/workflows/reproducibleR.yml</code>.</dd>


<dt>packages</dt>
<dd>Character. If NULL, necessary R packages are inferred automatically.</dd>

</dl>

use_github_action: Add GitHub Action to test reproducibility

Description

Usage

Value

Arguments