-
Notifications
You must be signed in to change notification settings - Fork 29
Expand file tree
/
Copy pathindex.html
More file actions
330 lines (311 loc) · 30.1 KB
/
index.html
File metadata and controls
330 lines (311 loc) · 30.1 KB
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en">
<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>Package R in Docker Containers • containerit</title>
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script><!-- sticky kit --><script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script><meta property="og:title" content="Package R in Docker Containers">
<meta property="og:description" content="Package R sessions, scripts, workspace directories, and R
Markdown documents together with all dependencies to execute them in
Docker containers. This package is supported by the project Opening
Reproducible Research (<https://o2r.info>).">
<meta property="og:image" content="/logo.png">
<meta name="twitter:card" content="summary">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></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-article">
<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" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">containerit</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.0</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="articles/containerit.html">Get started</a>
</li>
<li>
<a href="reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="articles/basic.html">Basic introduction to package containerit</a>
</li>
<li>
<a href="articles/bioconductor.html">Using Bioconductor with containerit</a>
</li>
<li>
<a href="articles/container.html">Using the containerit Docker image</a>
</li>
</ul>
</li>
<li>
<a href="news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/o2r-project/containerit">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul>
</div>
<!--/.nav-collapse -->
</div>
<!--/.container -->
</div>
<!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<!-- README.md is generated from README.Rmd. Please edit that file! -->
<div id="containerit" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
<a href="#containerit" class="anchor"></a>containerit <img src="reference/figures/logo.png" align="right" alt="containerit logo" width="200" style="padding: 0 0 10px 10px;">
</h1></div>
<!-- badges: start -->
<a href="https://doi.org/10.21105/joss.01603"><img src="https://joss.theoj.org/papers/10.21105/joss.01603/status.svg" alt="DOI"></a> <a href="https://www.repostatus.org/#wip"><img src="https://www.repostatus.org/badges/latest/wip.svg" alt="Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public."></a> <a href="https://travis-ci.org/o2r-project/containerit"><img src="https://travis-ci.org/o2r-project/containerit.svg?branch=master" alt="Travis CI build status"></a> <a href="https://ci.appveyor.com/project/nuest/containerit-rrvpq"><img src="https://ci.appveyor.com/api/projects/status/2242hcwagoafxaxq?svg=true" alt="Appveyor build status"></a> <a href="https://github.com/o2r-project/containerit/issues/68"><img src="https://www.r-pkg.org/badges/version/containerit"></a> <a href="https://gitter.im/o2r-project/containerit"><img src="https://badges.gitter.im/o2r-project/containerit.svg" alt="Join the chat at https://gitter.im/o2r-project/containerit"></a> <span class="altmetric-embed" data-badge-popover="bottom" data-badge-type="2" data-doi="10.21105/joss.01603" data-condensed="true" data-hide-no-mentions="true"></span> <!-- badges: end -->
<script type="text/javascript" src="https://d1bxh8uas1mnw7.cloudfront.net/assets/embed.js"></script><p><code>containerit</code> packages R script/session/workspace and all dependencies as a <a href="https://docker.com/">Docker</a> container by automagically generating a suitable <code>Dockerfile</code>. The package’s website is <a href="https://o2r.info/containerit/">https://o2r.info/containerit/</a>.</p>
<div id="prerequisites" class="section level2">
<h2 class="hasAnchor">
<a href="#prerequisites" class="anchor"></a>Prerequisites</h2>
<ul>
<li>
<code>containerit</code> only fully works if you have <a href="https://en.wikipedia.org/wiki/Docker_(software)">Docker</a> installed and is only tested with <a href="https://docs.docker.com/install/overview/">Docker Engine - Community</a> (previously called Docker Community Edition or Docker CE).</li>
<li>
<code>R (>= 3.5.0)</code> is needed so that some dependencies (e.g. BiocManager) are available; older versions of R predate the development of the package and were never tested.</li>
</ul>
</div>
<div id="quick-start" class="section level2">
<h2 class="hasAnchor">
<a href="#quick-start" class="anchor"></a>Quick start</h2>
<div id="try-out-containerit-in-a-container" class="section level3">
<h3 class="hasAnchor">
<a href="#try-out-containerit-in-a-container" class="anchor"></a>Try out <code>containerit</code> in a container</h3>
<p>You can spin up a Docker container with <code>containerit</code> pre-installed if you want to try out the package. The default of the <a href="#images"><code>containerit</code> images on Docker Hub</a> is to start plain R, but you can also start an with <a href="https://www.rstudio.com/products/rstudio/">RStudio</a> session in a browser.</p>
<p><strong>Note</strong>: The <code>geospatial</code> variant is used so that examples from <code>containerit</code> vignettes are likely to work. For a minimal <code>Dockerfile</code> to run <code>containerit</code>, see <code>inst/docker/minimal/Dockerfile</code>.</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb1-1" data-line-number="1"><span class="ex">docker</span> run --rm -it -e PASSWORD=o2r -p 8787:8787 o2rproject/containerit:geospatial /init</a></code></pre></div>
<p>Now go to <a href="http://localhost:8787" class="uri">http://localhost:8787</a> and log in with the user <code>rstudio</code> and password <code>o2r</code>. Continue in section <a href="#use">Use</a>.</p>
</div>
<div id="install" class="section level3">
<h3 class="hasAnchor">
<a href="#install" class="anchor"></a>Install</h3>
<p>Installation is only possible from GitHub:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb2-1" data-line-number="1"><span class="co"># install.packages("remotes")</span></a>
<a class="sourceLine" id="cb2-2" data-line-number="2">remotes<span class="op">::</span><span class="kw"><a href="https://www.rdocumentation.org/packages/remotes/topics/install_github">install_github</a></span>(<span class="st">"o2r-project/containerit"</span>)</a></code></pre></div>
</div>
<div id="use" class="section level3">
<h3 class="hasAnchor">
<a href="#use" class="anchor"></a>Use</h3>
<p><code>containerit</code> can create <code>Dockerfile</code> objects in R and render them as <code>Dockerfile</code> instructions based on session information objects or runnable R files (<code>.R</code>, <code>.Rmd</code>).</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb3-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/message">suppressPackageStartupMessages</a></span>(<span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/library">library</a></span>(<span class="st">"containerit"</span>))</a>
<a class="sourceLine" id="cb3-2" data-line-number="2">my_dockerfile <-<span class="st"> </span>containerit<span class="op">::</span><span class="kw"><a href="https://www.rdocumentation.org/packages/containerit/topics/dockerfile">dockerfile</a></span>(<span class="dt">from =</span> utils<span class="op">::</span><span class="kw"><a href="https://www.rdocumentation.org/packages/utils/topics/sessionInfo">sessionInfo</a></span>())</a>
<a class="sourceLine" id="cb3-3" data-line-number="3"><span class="co">#> INFO [2019-08-21 19:35:15] Going online? TRUE ... to retrieve system dependencies (sysreq-api)</span></a>
<a class="sourceLine" id="cb3-4" data-line-number="4"><span class="co">#> INFO [2019-08-21 19:35:15] Trying to determine system requirements for the package(s) 'assertthat,backports,commonmark,crayon,curl,desc,digest,evaluate,formatR,fs,futile.logger,futile.options,htmltools,httpuv,jsonlite,knitr,lambda.r,later,magrittr,MASS,memoise,mime,miniUI,pillar,pkgconfig,pkgdown,promises,R6,Rcpp,rlang,rmarkdown,roxygen2,rprojroot,rstudioapi,semver,shiny,shinyFiles,stevedore,stringi,stringr,tibble,versions,xfun,xml2,xtable,yaml' from sysreqs online DB</span></a>
<a class="sourceLine" id="cb3-5" data-line-number="5"><span class="co">#> INFO [2019-08-21 19:35:18] Adding CRAN packages: assertthat, backports, commonmark, crayon, curl, desc, digest, evaluate, formatR, fs, futile.logger, futile.options, htmltools, httpuv, jsonlite, knitr, lambda.r, later, magrittr, MASS, memoise, mime, miniUI, pillar, pkgconfig, pkgdown, promises, R6, Rcpp, rlang, rmarkdown, roxygen2, rprojroot, rstudioapi, semver, shiny, shinyFiles, stevedore, stringi, stringr, tibble, versions, xfun, xml2, xtable, yaml</span></a>
<a class="sourceLine" id="cb3-6" data-line-number="6"><span class="co">#> INFO [2019-08-21 19:35:18] Created Dockerfile-Object based on sessionInfo</span></a></code></pre></div>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb4-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/print">print</a></span>(my_dockerfile)</a>
<a class="sourceLine" id="cb4-2" data-line-number="2"><span class="co">#> FROM rocker/r-ver:3.6.1</span></a>
<a class="sourceLine" id="cb4-3" data-line-number="3"><span class="co">#> LABEL maintainer="daniel"</span></a>
<a class="sourceLine" id="cb4-4" data-line-number="4"><span class="co">#> RUN export DEBIAN_FRONTEND=noninteractive; apt-get -y update \</span></a>
<a class="sourceLine" id="cb4-5" data-line-number="5"><span class="co">#> && apt-get install -y git-core \</span></a>
<a class="sourceLine" id="cb4-6" data-line-number="6"><span class="co">#> libcurl4-openssl-dev \</span></a>
<a class="sourceLine" id="cb4-7" data-line-number="7"><span class="co">#> libssl-dev \</span></a>
<a class="sourceLine" id="cb4-8" data-line-number="8"><span class="co">#> libxml2-dev \</span></a>
<a class="sourceLine" id="cb4-9" data-line-number="9"><span class="co">#> make \</span></a>
<a class="sourceLine" id="cb4-10" data-line-number="10"><span class="co">#> pandoc \</span></a>
<a class="sourceLine" id="cb4-11" data-line-number="11"><span class="co">#> pandoc-citeproc</span></a>
<a class="sourceLine" id="cb4-12" data-line-number="12"><span class="co">#> RUN ["install2.r", "assertthat", "backports", "commonmark", "crayon", "curl", "desc", "digest", "evaluate", "formatR", "fs", "futile.logger", "futile.options", "htmltools", "httpuv", "jsonlite", "knitr", "lambda.r", "later", "magrittr", "MASS", "memoise", "mime", "miniUI", "pillar", "pkgconfig", "pkgdown", "promises", "R6", "Rcpp", "rlang", "rmarkdown", "roxygen2", "rprojroot", "rstudioapi", "semver", "shiny", "shinyFiles", "stevedore", "stringi", "stringr", "tibble", "versions", "xfun", "xml2", "xtable", "yaml"]</span></a>
<a class="sourceLine" id="cb4-13" data-line-number="13"><span class="co">#> WORKDIR /payload/</span></a>
<a class="sourceLine" id="cb4-14" data-line-number="14"><span class="co">#> CMD ["R"]</span></a></code></pre></div>
<p>You can disable logging:</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb5-1" data-line-number="1">futile.logger<span class="op">::</span><span class="kw">flog.threshold</span>(futile.logger<span class="op">::</span>ERROR)</a></code></pre></div>
<p>Now we create a Dockerfile for a specific R version and R Markdown file and do not add any packages already available in the base image:</p>
<div class="sourceCode" id="cb6"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb6-1" data-line-number="1">rmd_dockerfile <-<span class="st"> </span>containerit<span class="op">::</span><span class="kw"><a href="https://www.rdocumentation.org/packages/containerit/topics/dockerfile">dockerfile</a></span>(<span class="dt">from =</span> <span class="st">"inst/demo.Rmd"</span>,</a>
<a class="sourceLine" id="cb6-2" data-line-number="2"> <span class="dt">image =</span> <span class="st">"rocker/verse:3.5.2"</span>,</a>
<a class="sourceLine" id="cb6-3" data-line-number="3"> <span class="dt">maintainer =</span> <span class="st">"o2r"</span>,</a>
<a class="sourceLine" id="cb6-4" data-line-number="4"> <span class="dt">filter_baseimage_pkgs =</span> <span class="ot">TRUE</span>)</a>
<a class="sourceLine" id="cb6-5" data-line-number="5"><span class="co">#> Detected API version '1.40' is above max version '1.39'; downgrading</span></a>
<a class="sourceLine" id="cb6-6" data-line-number="6"><span class="co">#> Detected API version '1.40' is above max version '1.39'; downgrading</span></a>
<a class="sourceLine" id="cb6-7" data-line-number="7"><span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/print">print</a></span>(rmd_dockerfile)</a>
<a class="sourceLine" id="cb6-8" data-line-number="8"><span class="co">#> FROM rocker/verse:3.5.2</span></a>
<a class="sourceLine" id="cb6-9" data-line-number="9"><span class="co">#> LABEL maintainer="o2r"</span></a>
<a class="sourceLine" id="cb6-10" data-line-number="10"><span class="co">#> # CRAN packages skipped because they are in the base image: assertthat, backports, cli, crayon, curl, desc, digest, evaluate, formatR, fs, htmltools, httpuv, jsonlite, knitr, later, magrittr, mime, miniUI, pillar, pkgconfig, promises, R6, Rcpp, rlang, rmarkdown, rprojroot, rstudioapi, sessioninfo, shiny, stringi, stringr, tibble, withr, xfun, xtable, yaml</span></a>
<a class="sourceLine" id="cb6-11" data-line-number="11"><span class="co">#> RUN ["install2.r", "fortunes", "futile.logger", "futile.options", "lambda.r", "semver", "shinyFiles", "stevedore", "versions"]</span></a>
<a class="sourceLine" id="cb6-12" data-line-number="12"><span class="co">#> WORKDIR /payload/</span></a>
<a class="sourceLine" id="cb6-13" data-line-number="13"><span class="co">#> CMD ["R"]</span></a></code></pre></div>
<p>For extended instructions, see the vignettes at in the directory <code>vignettes/</code>, which are readable online at <a href="https://o2r.info/containerit/articles/" class="uri">https://o2r.info/containerit/articles/</a>.</p>
</div>
</div>
<div id="images" class="section level2">
<h2 class="hasAnchor">
<a href="#images" class="anchor"></a>Images</h2>
<p>Images are available starting from different base images. All images are also available with version tags.</p>
<p>The <code>Dockerfile</code>s are available in the directory <code>inst/docker/Dockerfile</code>.</p>
<div id="verse" class="section level3">
<h3 class="hasAnchor">
<a href="#verse" class="anchor"></a>verse</h3>
<div class="sourceCode" id="cb7"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb7-1" data-line-number="1"><span class="ex">docker</span> inspect o2rproject/containerit</a></code></pre></div>
<p>Base image: <code>rocker/verse:3.5.3</code></p>
<p><a href="https://microbadger.com/images/o2rproject/containerit" title="Get your own version badge on microbadger.com"><img src="https://images.microbadger.com/badges/version/o2rproject/containerit.svg"></a> <a href="https://microbadger.com/images/o2rproject/containerit" title="Get your own image badge on microbadger.com"><img src="https://images.microbadger.com/badges/image/o2rproject/containerit.svg"></a> <a href="https://microbadger.com/images/o2rproject/containerit" title="Get your own commit badge on microbadger.com"><img src="https://images.microbadger.com/badges/commit/o2rproject/containerit.svg"></a></p>
</div>
<div id="geospatial" class="section level3">
<h3 class="hasAnchor">
<a href="#geospatial" class="anchor"></a>geospatial</h3>
<div class="sourceCode" id="cb8"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb8-1" data-line-number="1"><span class="ex">docker</span> inspect o2rproject/containerit:geospatial</a></code></pre></div>
<p>Base image: <code>rocker/geospatial:3.5.3</code></p>
<p><a href="https://microbadger.com/images/o2rproject/containerit:geospatial" title="Get your own version badge on microbadger.com"><img src="https://images.microbadger.com/badges/version/o2rproject/containerit:geospatial.svg"></a> <a href="https://microbadger.com/images/o2rproject/containerit:geospatial" title="Get your own image badge on microbadger.com"><img src="https://images.microbadger.com/badges/image/o2rproject/containerit:geospatial.svg"></a> <a href="https://microbadger.com/images/o2rproject/containerit:geospatial" title="Get your own commit badge on microbadger.com"><img src="https://images.microbadger.com/badges/commit/o2rproject/containerit:geospatial.svg"></a></p>
</div>
</div>
<div id="rstudio-add-in" class="section level2">
<h2 class="hasAnchor">
<a href="#rstudio-add-in" class="anchor"></a>RStudio Add-in</h2>
<p><a href="https://rstudio.github.io/rstudioaddins/">RStudio Addins</a> allow to create interactive user interfaces for the RStudio development environment. Courtesy of a great contribution by a <a href="https://github.com/o2r-project/containerit/issues/27#issuecomment-440869329">group of enthusiasts</a> at the <a href="https://ozunconf18.ropensci.org/">ROpenSci OZ Unconference 2018</a>, there are several forms to quickly create <code>Dockefile</code>s from different use cases, e.g. the current session, a vector of expressions, or a script file.</p>
<div class="figure">
<img src="https://user-images.githubusercontent.com/1325054/61534429-e1345980-aa2f-11e9-8f5d-e6f67e5d7dde.png" alt="screenshots containerit RStudio Addin forms"><p class="caption">screenshots containerit RStudio Addin forms</p>
</div>
</div>
<div id="contribute" class="section level2">
<h2 class="hasAnchor">
<a href="#contribute" class="anchor"></a>Contribute</h2>
<p>All help is welcome: asking questions, providing documentation, testing, or even development.</p>
<p>Please note that this project is released with a <a href="CONDUCT.html">Contributor Code of Conduct</a>. By participating in this project you agree to abide by its terms.</p>
<p>See <a href="CONTRIBUTING.html">CONTRIBUTING.md</a> for details.</p>
</div>
<div id="development" class="section level2">
<h2 class="hasAnchor">
<a href="#development" class="anchor"></a>Development</h2>
<p><a href="https://builder.r-hub.io/">r-hub builder</a> is great for running checks, e.g. before submitting to CRAN and on other operating systems.</p>
<div class="sourceCode" id="cb9"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb9-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/base/topics/library">library</a></span>(<span class="st">"rhub"</span>)</a>
<a class="sourceLine" id="cb9-2" data-line-number="2">rhub<span class="op">::</span><span class="kw"><a href="https://r-hub.github.io/rhub/reference/check_for_cran.html">check_for_cran</a></span>()</a>
<a class="sourceLine" id="cb9-3" data-line-number="3">rhub<span class="op">::</span><span class="kw"><a href="https://r-hub.github.io/rhub/reference/check_shortcuts.html">check_on_windows</a></span>()</a></code></pre></div>
<p>You can build the <a href="https://pkgdown.r-lib.org/"><code>pkgdown</code></a> site with</p>
<div class="sourceCode" id="cb10"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb10-1" data-line-number="1">pkgdown<span class="op">::</span><span class="kw"><a href="https://pkgdown.r-lib.org/reference/build_site.html">build_site</a></span>()</a></code></pre></div>
<p>You can build the Docker images locally with the current development version using the following commands.</p>
<div class="sourceCode" id="cb11"><pre class="sourceCode bash"><code class="sourceCode bash"><a class="sourceLine" id="cb11-1" data-line-number="1"><span class="ex">docker</span> build --tag containerit:dev --file inst/docker/Dockerfile.local .</a>
<a class="sourceLine" id="cb11-2" data-line-number="2"><span class="ex">docker</span> build --tag containerit:geospatial-dev --file inst/docker/geospatial/Dockerfile.local .</a></code></pre></div>
<p>You can use <a href="https://github.com/lorenzwalthert/pre-commit-hooks"><code>pre-commit</code> hooks</a> to avoid some mistakes.</p>
<p>A <a href="https://codemeta.github.io/">codemeta</a> file, <code>codemeta.json</code>, with metadata about the package and its dependencies is generated automatically when this document is compiled.</p>
<div class="sourceCode" id="cb12"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb12-1" data-line-number="1">codemetar<span class="op">::</span><span class="kw"><a href="https://ropensci.github.io/codemetar/reference/write_codemeta.html">write_codemeta</a></span>(<span class="st">"containerit"</span>)</a>
<a class="sourceLine" id="cb12-2" data-line-number="2"><span class="co">#> Registered S3 method overwritten by 'httr':</span></a>
<a class="sourceLine" id="cb12-3" data-line-number="3"><span class="co">#> method from</span></a>
<a class="sourceLine" id="cb12-4" data-line-number="4"><span class="co">#> as.character.form_file crul</span></a></code></pre></div>
</div>
<div id="citation" class="section level2">
<h2 class="hasAnchor">
<a href="#citation" class="anchor"></a>Citation</h2>
<div class="sourceCode" id="cb13"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb13-1" data-line-number="1"><span class="kw"><a href="https://www.rdocumentation.org/packages/utils/topics/citation">citation</a></span>(<span class="st">"containerit"</span>)</a>
<a class="sourceLine" id="cb13-2" data-line-number="2"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-3" data-line-number="3"><span class="co">#> To cite containerit in publications use:</span></a>
<a class="sourceLine" id="cb13-4" data-line-number="4"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-5" data-line-number="5"><span class="co">#> Nüst, D. and Hinz, M. (2019). containerit: Generating</span></a>
<a class="sourceLine" id="cb13-6" data-line-number="6"><span class="co">#> Dockerfiles for reproducible research with R. Journal of Open</span></a>
<a class="sourceLine" id="cb13-7" data-line-number="7"><span class="co">#> Source Software, 4(40), 1603,</span></a>
<a class="sourceLine" id="cb13-8" data-line-number="8"><span class="co">#> https://doi.org/10.21105/joss.01603</span></a>
<a class="sourceLine" id="cb13-9" data-line-number="9"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-10" data-line-number="10"><span class="co">#> A BibTeX entry for LaTeX users is</span></a>
<a class="sourceLine" id="cb13-11" data-line-number="11"><span class="co">#> </span></a>
<a class="sourceLine" id="cb13-12" data-line-number="12"><span class="co">#> @Article{,</span></a>
<a class="sourceLine" id="cb13-13" data-line-number="13"><span class="co">#> title = {{containerit: Generating Dockerfiles for reproducible research with R}},</span></a>
<a class="sourceLine" id="cb13-14" data-line-number="14"><span class="co">#> author = {Daniel Nüst and Matthias Hinz},</span></a>
<a class="sourceLine" id="cb13-15" data-line-number="15"><span class="co">#> journal = {{Journal of Open Source Software}},</span></a>
<a class="sourceLine" id="cb13-16" data-line-number="16"><span class="co">#> year = {2019},</span></a>
<a class="sourceLine" id="cb13-17" data-line-number="17"><span class="co">#> month = {8},</span></a>
<a class="sourceLine" id="cb13-18" data-line-number="18"><span class="co">#> volume = {4},</span></a>
<a class="sourceLine" id="cb13-19" data-line-number="19"><span class="co">#> number = {40},</span></a>
<a class="sourceLine" id="cb13-20" data-line-number="20"><span class="co">#> pages = {1603},</span></a>
<a class="sourceLine" id="cb13-21" data-line-number="21"><span class="co">#> doi = {10.21105/joss.01603},</span></a>
<a class="sourceLine" id="cb13-22" data-line-number="22"><span class="co">#> url = {https://doi.org/10.21105/joss.01603},</span></a>
<a class="sourceLine" id="cb13-23" data-line-number="23"><span class="co">#> }</span></a></code></pre></div>
</div>
<div id="license" class="section level2">
<h2 class="hasAnchor">
<a href="#license" class="anchor"></a>License</h2>
<p>containerit is licensed under GNU General Public License, version 3, see file LICENSE.</p>
<p>Copyright (C) 2019 - o2r project.</p>
</div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Browse source code at <br><a href="https://github.com/o2r-project/containerit">https://github.com/o2r-project/containerit</a>
</li>
<li>Report a bug at <br><a href="https://github.com/o2r-project/containerit/issues">https://github.com/o2r-project/containerit/issues</a>
</li>
</ul>
</div>
<div class="license">
<h2>License</h2>
<ul class="list-unstyled">
<li>
<a href="https://www.r-project.org/Licenses/GPL-3">GPL-3</a> + file <a href="LICENSE-text.html">LICENSE</a>
</li>
</ul>
</div>
<div class="citation">
<h2>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html">Citing containerit</a></li>
</ul>
</div>
<div class="developers">
<h2>Developers</h2>
<ul class="list-unstyled">
<li>Daniel Nuest <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0003-2392-6140" target="orcid.widget"><img src="https://members.orcid.org/sites/default/files/vector_iD_icon.svg" class="orcid" alt="ORCID" height="16"></a> </li>
<li>Matthias Hinz <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0001-6837-9406" target="orcid.widget"><img src="https://members.orcid.org/sites/default/files/vector_iD_icon.svg" class="orcid" alt="ORCID" height="16"></a> </li>
<li><a href="authors.html">All authors...</a></li>
</ul>
</div>
<div class="dev-status">
<h2>Dev status</h2>
<ul class="list-unstyled">
<li><a href="https://doi.org/10.21105/joss.01603"><img src="https://joss.theoj.org/papers/10.21105/joss.01603/status.svg" alt="DOI"></a></li>
<li><a href="https://www.repostatus.org/#wip"><img src="https://www.repostatus.org/badges/latest/wip.svg" alt="Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public."></a></li>
<li><a href="https://travis-ci.org/o2r-project/containerit"><img src="https://travis-ci.org/o2r-project/containerit.svg?branch=master" alt="Travis CI build status"></a></li>
<li><a href="https://ci.appveyor.com/project/nuest/containerit-rrvpq"><img src="https://ci.appveyor.com/api/projects/status/2242hcwagoafxaxq?svg=true" alt="Appveyor build status"></a></li>
<li><a href="https://github.com/o2r-project/containerit/issues/68"><img src="https://www.r-pkg.org/badges/version/containerit"></a></li>
<li><a href="https://gitter.im/o2r-project/containerit"><img src="https://badges.gitter.im/o2r-project/containerit.svg" alt="Join the chat at https://gitter.im/o2r-project/containerit"></a></li>
</ul>
</div>
</div>
</div>
<footer><div class="copyright">
<p>Developed by Daniel Nuest, Matthias Hinz.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
</div>
</footer>
</div>
</body>
</html>