use_codespace

Generate a dev container config file to set up a 
<a href="https://docs.github.com/en/codespaces">GitHub Codespace</a>.

Reproducibility is essential to the progress of research,
yet achieving it remains elusive even in computational fields.
Continuous Integration (CI) platforms offer a powerful way to launch automated workflows
to check and document code, but often require considerable time, effort,
and technical expertise to setup. We therefore developed the rworkflows suite
to make robust CI workflows easy and freely accessible to all R package developers.
rworkflows consists of 1) a CRAN/Bioconductor-compatible R package template,
2) an R package to quickly implement a standardised workflow, and
3) a centrally maintained GitHub Action.

Brian Schilder

rworkflows

Test, Document, Containerise, and Deploy R Packages

use_codespace function

<dl><dt>template</dt>
<dd>Dev container config template to use.</dd>
<dt>image</dt>
<dd>Base Docker image to use for the Codespace.</dd>
<dt>features</dt>
<dd>Named list of features to add to the Codespace.
See <a href="https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file">here</a>
 for details.</dd>
<dt>customizations</dt>
<dd>Named list of customizations to add to the Codespace.
See <a href="https://containers.dev/supporting">here</a>
 for details.</dd>
<dt>save_dir</dt>
<dd>Directory to save the file to.</dd>
<dt>path</dt>
<dd>Path to the file.</dd>
<dt>force_new</dt>
<dd>If the file already exists, overwrite it 
(default: <code>FALSE</code>).</dd>
<dt>show</dt>
<dd>Print the contents of the file in the R console.</dd>
<dt>verbose</dt>
<dd>Print messages.</dd></dl>

Arguments

Generate a dev container config file to set up a 
<a href='https://docs.github.com/en/codespaces'>GitHub Codespace</a>.

Use Codespace — use_codespace

<dl>

<dt>template</dt>
<dd>Dev container config template to use.</dd>


<dt>image</dt>
<dd>Base Docker image to use for the Codespace.</dd>


<dt>features</dt>
<dd>Named list of features to add to the Codespace.
See <a href='https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file'>here</a>
 for details.</dd>


<dt>customizations</dt>
<dd>Named list of customizations to add to the Codespace.
See <a href='https://containers.dev/supporting'>here</a>
 for details.</dd>


<dt>save_dir</dt>
<dd>Directory to save the file to.</dd>


<dt>path</dt>
<dd>Path to the file.</dd>


<dt>force_new</dt>
<dd>If the file already exists, overwrite it 
(default: <code>FALSE</code>).</dd>


<dt>show</dt>
<dd>Print the contents of the file in the R console.</dd>


<dt>verbose</dt>
<dd>Print messages.</dd>

</dl>

use_codespace: Use Codespace

Description

Usage

Value

Arguments

Examples