Generate large remake-style workflows with minimal code.
HTML R Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
articles
inst/examples
man
news
reference
tests
vignettes
.Rbuildignore
.gitignore
.travis.yml
DESCRIPTION
NAMESPACE
NEWS.md
README.md
TROUBLESHOOTING.md
_config.yml
appveyor.yml
authors.html
build_site.R
cran-comments.md
index.html
jquery.sticky-kit.min.js
link.svg
pkgdown.css
pkgdown.js
remakeGenerator.Rproj

README.md

remakeGenerator

Travis-CI Build Status AppVeyor Build Status codecov.io CRAN_Status_Badge

The remakeGenerator package is a helper add-on for remake, a Makefile-like reproducible build system for R. If you haven't done so already, go learn remake! Once you do that, you will be ready to use remakeGenerator. With remakeGenerator, your long and cumbersome workflows will be

  • Quick to set up. You can plan a large workflow with a small amount of code.
  • Reproducible. Reproduce computation with remake::make() or GNU Make.
  • Development-friendly. Thanks to remake, whenever you change your code, your next computation will only run the parts that are new or out of date.
  • Parallelizable. Distribute your workflow over multiple parallel processes with a single flag in GNU Make.

The remakeGenerator package accomplishes this by generating YAML files for remake that would be too big to type manually.

Drake

Drake is a standalone version of remakeGenerator and borrows many of the ideas of remake.

Installation

First, ensure that R is installed, as well as the dependencies in the DESCRIPTION. To install the latest CRAN release, run

install.packages("remakeGenerator")

To install the development version, get the devtools package and then run

devtools::install_github("wlandau/remakeGenerator", build = TRUE)

If you specify a tag, you can install a GitHub release.

devtools::install_github("wlandau/remakeGenerator@v0.1.0", build = TRUE)

Rtools for Windows users

Windows users may need Rtools to take full advantage of remakeGenerator's features, specifically to run Makefiles with system("make").

Tutorial

The online package vignette has a complete tutorial. You can the load the compiled version from an R session.

vignette("remakeGenerator")

Help and troubleshooting

Use the help_remakeGenerator() function to obtain a collection of helpful links. For troubleshooting, please refer to TROUBLESHOOTING.md on the GitHub page for instructions.

Acknowledgements

This package stands on the shoulders of Rich FitzJohn's remake package.