https://github.com/wlandau/parallelremake
Accelerate make/remake workflows in R.
https://github.com/wlandau/parallelremake
Last synced: about 1 month ago
JSON representation
Accelerate make/remake workflows in R.
- Host: GitHub
- URL: https://github.com/wlandau/parallelremake
- Owner: wlandau
- Created: 2016-05-17T21:17:34.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2020-10-27T16:34:19.000Z (over 4 years ago)
- Last Synced: 2025-02-14T12:40:42.430Z (3 months ago)
- Language: HTML
- Homepage: http://will-landau.com/parallelRemake
- Size: 1.03 MB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Authors: authors.html
Awesome Lists containing this project
README
# Drake, the successor to parallelRemake
[Drake](https://github.com/wlandau-lilly/drake) is a newer, standalone, [CRAN-published](https://CRAN.R-project.org/package=drake) [Make](https://www.gnu.org/software/make/)-like build system. It has the convenience of [remakeGenerator](https://github.com/wlandau/remakeGenerator), the reproducibility of [remake](https://github.com/richfitz/remake), and more comprehensive built-in parallel computing functionality than [parallelRemake](https://github.com/wlandau/parallelRemake).
# parallelRemake
[](https://travis-ci.org/wlandau/parallelRemake)
[](https://ci.appveyor.com/project/wlandau/parallelRemake)
[](https://codecov.io/github/wlandau/parallelRemake?branch=master)
[](http://cran.r-project.org/package=parallelRemake)
The `parallelRemake` package is a helper add-on for [`remake`](https://github.com/richfitz/remake), a [Makefile](https://www.gnu.org/software/make/)-like reproducible build system for R. If you haven't done so already, go learn [`remake`](https://github.com/richfitz/remake)! Also learn [GNU make](https://www.gnu.org/software/make/), and then recall that `make -j 4` runs a [Makefile](https://www.gnu.org/software/make/) while distributing the rules over four parallel processes. This mode of parallelism is the whole point of `parallelRemake`. With `parallelRemake`, you can write an overarching [Makefile](https://www.gnu.org/software/make/) for a [`remake`](https://github.com/richfitz/remake) project to run [`remake`](https://github.com/richfitz/remake) targets in parallel. This distributed parallelism is extremely helpful for large clusters that use the [Slurm job scheduler](http://slurm.schedmd.com/), for example, as explained in [this post](http://plindenbaum.blogspot.com/2014/09/parallelizing-gnu-make-4-in-slurm.html).
# Installation
To install the development version, get the [devtools](https://cran.r-project.org/web/packages/devtools/) package and run
```
devtools::install_github("wlandau/parallelRemake", build = TRUE)
```
If you specify a tag, you can install a GitHub release.
```r
devtools::install_github("wlandau/[email protected]", build = TRUE)
```
# Rtools for Windows users
The example and tests sometimes use `system("make")` and similar commands. So if you're using the Windows operating system, you will need to install the [`Rtools`](https://github.com/stan-dev/rstan/wiki/Install-Rtools-for-Windows) package.
# Tutorial
The [online package vignette](https://github.com/wlandau/parallelRemake/blob/master/vignettes/parallelRemake.Rmd) has a complete tutorial. You can load the compiled version from an R session.
```r
vignette("parallelRemake")
```
# Help and troubleshooting
Use the `help_parallelRemake()` function to obtain a collection of helpful links. For troubleshooting, please refer to [TROUBLESHOOTING.md](https://github.com/wlandau/parallelRemake/blob/master/TROUBLESHOOTING.md) on the [GitHub page](https://github.com/wlandau/parallelRemake) for instructions.
# Acknowledgements
This package stands on the shoulders of [Rich FitzJohn](https://richfitz.github.io/)'s [`remake`](https://github.com/richfitz/remake) package. Also thanks to [Daniel Falster](http://danielfalster.com/) for [the idea](https://github.com/richfitz/remake/issues/84) that made `parallelRemake` practical and clean.