Citation
If you use rworkflows, please cite:
Schilder, B.M., Murphy, A.E. & Skene, N.G. rworkflows: automating reproducible practices for the R community. Nat Commun 15, 149 (2024). https://doi.org/10.1038/s41467-023-44484-5
Intro
rworkflows is a suite of tools to make it easy for R developers to
implement reproducible best practices on GitHub.
It includes three main components:
- [**
templateR
template**](https://github.com/neurogenomics/templateR): a
CRAN/Bioc-compatible R package template that automatically generates
essential documentation using package metadata.
2. rworkflows R
package:
a lightweight CRAN package to automatically set up short, customisable
workflows that trigger the rworkflows action.
3. rworkflows
action:
an open-source action available on the GitHub Actions
Marketplace.
rworkflows action steps
GitHub Actions are a powerful way to automatically launch workflows every time you push changes to a GitHub repository. This is a form of Continuous Integration/Deployment (CI/CD), which helps ensure that your code is always working as expected (without having to manually check each time).
Here, we have designed a robust, reusable, and flexible action
specifically for the development of R packages. We also provide an R
function to automatically generate a workflow file that calls the
rworkflows composite action:
Currently, rworkflows action can perform the following tasks (with
options to enable/disable/modify each step):