/
index.html
111 lines (100 loc) · 8.96 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Automated Generation of Remake-Style Workflows • remakeGenerator</title><!-- jquery --><script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous"><script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script><!-- Font Awesome icons --><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous"><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet"><script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><!-- mathjax --><script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body>
<div class="container template-home">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">remakeGenerator</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="reference/index.html">Reference</a>
</li>
<li>
<a href="articles/index.html">Articles</a>
</li>
<li>
<a href="news/index.html">News</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="contents col-md-9">
<div id="remakegenerator" class="section level1">
<div class="page-header"><h1 class="hasAnchor"><a href="#remakegenerator" class="anchor"> </a>remakeGenerator</h1></div>
<p>The <code>remakeGenerator</code> package is a helper add-on for <a href="https://github.com/richfitz/remake"><code>remake</code></a>, a <a href="https://www.gnu.org/software/make/">Makefile</a>-like reproducible build system for R. If you haven’t done so already, go learn <a href="https://github.com/richfitz/remake"><code>remake</code></a>! Once you do that, you will be ready to use <code>remakeGenerator</code>. With <code>remakeGenerator</code>, your long and cumbersome workflows will be</p>
<ul><li>
<strong>Quick to set up</strong>. You can plan a large workflow with a small amount of code.</li>
<li>
<strong>Reproducible</strong>. Reproduce computation with <code>remake::make()</code> or <a href="https://www.gnu.org/software/make/">GNU Make</a>.</li>
<li>
<strong>Development-friendly</strong>. Thanks to <a href="https://github.com/richfitz/remake"><code>remake</code></a>, whenever you change your code, your next computation will only run the parts that are new or out of date.</li>
<li>
<strong>Parallelizable</strong>. Distribute your workflow over multiple parallel processes with a single flag in <a href="https://www.gnu.org/software/make/">GNU Make</a>.</li>
</ul><p>The <code>remakeGenerator</code> package accomplishes this by generating <a href="http://yaml.org/">YAML</a> files for <a href="https://github.com/richfitz/remake"><code>remake</code></a> that would be too big to type manually.</p>
</div>
<div id="installation" class="section level1">
<h1 class="hasAnchor">
<a href="#installation" class="anchor"> </a>Installation</h1>
<p>First, ensure that <a href="https://www.r-project.org/">R</a> is installed, as well as the dependencies in the <a href="https://github.com/wlandau/remakeGenerator/blob/master/DESCRIPTION"><code>DESCRIPTION</code></a>. To install the <a href="https://cran.r-project.org/web/packages/remakeGenerator/">latest CRAN release</a>, run</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">install.packages</span>(<span class="st">"remakeGenerator"</span>)</code></pre></div>
<p>To install the development version, get the <a href="https://cran.r-project.org/web/packages/devtools/">devtools</a> package and then run</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">devtools::<span class="kw">install_github</span>(<span class="st">"wlandau/remakeGenerator"</span>, <span class="dt">build =</span> <span class="ot">TRUE</span>)</code></pre></div>
<p>If you specify a tag, you can install a GitHub release.</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">devtools::<span class="kw">install_github</span>(<span class="st">"wlandau/remakeGenerator@v0.1.0"</span>, <span class="dt">build =</span> <span class="ot">TRUE</span>)</code></pre></div>
</div>
<div id="rtools-for-windows-users" class="section level1">
<h1 class="hasAnchor">
<a href="#rtools-for-windows-users" class="anchor"> </a>Rtools for Windows users</h1>
<p>Windows users may need <a href="https://github.com/stan-dev/rstan/wiki/Install-Rtools-for-Windows"><code>Rtools</code></a> to take full advantage of <code>remakeGenerator</code>’s features, specifically to run <a href="https://www.gnu.org/software/make/">Makefiles</a> with <code>system("make")</code>.</p>
</div>
<div id="tutorial" class="section level1">
<h1 class="hasAnchor">
<a href="#tutorial" class="anchor"> </a>Tutorial</h1>
<p>The <a href="https://github.com/wlandau/remakeGenerator/blob/master/vignettes/remakeGenerator.Rmd">online package vignette</a> has a complete tutorial. You can the load the compiled version from an R session.</p>
<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">vignette</span>(<span class="st">"remakeGenerator"</span>)</code></pre></div>
</div>
<div id="help-and-troubleshooting" class="section level1">
<h1 class="hasAnchor">
<a href="#help-and-troubleshooting" class="anchor"> </a>Help and troubleshooting</h1>
<p>Use the <code><a href="reference/help_remakeGenerator.html">help_remakeGenerator()</a></code> function to obtain a collection of helpful links. For troubleshooting, please refer to <a href="https://github.com/wlandau/remakeGenerator/blob/master/TROUBLESHOOTING.md">TROUBLESHOOTING.md</a> on the <a href="https://github.com/wlandau/remakeGenerator">GitHub page</a> for instructions.</p>
</div>
<div id="acknowledgements" class="section level1">
<h1 class="hasAnchor">
<a href="#acknowledgements" class="anchor"> </a>Acknowledgements</h1>
<p>This package stands on the shoulders of <a href="https://richfitz.github.io/">Rich FitzJohn</a>’s <a href="https://github.com/richfitz/remake"><code>remake</code></a> package.</p>
</div>
</div>
<div class="col-md-3" id="sidebar">
<h2>Links</h2><ul class="list-unstyled"><li>Report a bug at <br><a href="https://github.com/wlandau/remakeGenerator/issues">https://​github.com/​wlandau/​remakeGenerator/​issues</a></li>
</ul><h2>License</h2>
<p>GPL (>=3)</p>
<h2>Developers</h2><ul class="list-unstyled"><li>William Michael Landau <br><small class="roles"> Author, copyright holder, maintainer </small> </li>
<li><a href="authors.html">All authors...</a></li>
</ul><html><body><h2>Dev status</h2><ul class="list-unstyled"><li><a href="https://travis-ci.org/wlandau/remakeGenerator">
<img src="https://travis-ci.org/wlandau/remakeGenerator.svg?branch=master" alt="Travis-CI Build Status"></a></li>
<li><a href="https://ci.appveyor.com/project/wlandau/remakeGenerator">
<img src="https://ci.appveyor.com/api/projects/status/github/wlandau/remakeGenerator?branch=master&svg=true" alt="AppVeyor Build Status"></a></li>
<li><a href="https://codecov.io/github/wlandau/remakeGenerator?branch=master">
<img src="https://codecov.io/github/wlandau/remakeGenerator/coverage.svg?branch=master" alt="codecov.io"></a></li>
<li><a href="http://cran.r-project.org/package=remakeGenerator">
<img src="http://www.r-pkg.org/badges/version/remakeGenerator" alt="CRAN_Status_Badge"></a></li>
</ul></body></html></div>
</div>
<footer><div class="copyright">
<p>Developed by William Michael Landau.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
</div>
</footer></div>
</body></html>