123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213 |
- <!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>Containerize R Markdown Documents • liftr</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/bootswatch/3.3.7/flatly/bootstrap.min.css" rel="stylesheet" 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://mathjax.rstudio.com/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]--><!-- Google analytics --><script>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
- ga('create', 'UA-65001771-1', 'auto');
- ga('send', 'pageview');
- </script>
- </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">liftr</a>
- </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="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/liftr-addins.html">RStudio Addins for liftr</a>
- </li>
- <li>
- <a href="articles/liftr-intro.html">A Quick Introduction to liftr</a>
- </li>
- <li>
- <a href="articles/liftr-tidyverse.html">Explore tidyverse with liftr</a>
- </li>
- </ul>
- </li>
- <li>
- <a href="news/index.html">News</a>
- </li>
- </ul>
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="https://github.com/road2stat/liftr">
- <span class="fa fa-github fa-lg"></span>
-
- </a>
- </li>
- </ul>
- </div>
- <!--/.nav-collapse -->
- </div>
- <!--/.container -->
- </div>
- <!--/.navbar -->
-
- </header><div class="row">
- <div class="contents col-md-9">
- <div id="liftr" class="section level1">
- <div class="page-header"><h1 class="hasAnchor">
- <a href="#liftr" class="anchor"></a>liftr <a href="https://liftr.me"><img src="https://i.imgur.com/3SCYZu0.png" align="right" alt="logo" height="180" width="180"></a>
- </h1></div>
- <p>liftr aims to solve the problem of <em>persistent reproducible reporting</em>. To achieve this goal, it extends the <a href="http://rmarkdown.rstudio.com">R Markdown</a> metadata format, and uses Docker to containerize and render R Markdown documents.</p>
- <div id="installation" class="section level2">
- <h2 class="hasAnchor">
- <a href="#installation" class="anchor"></a>Installation</h2>
- <p>Install liftr from CRAN:</p>
- <div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="kw">install.packages</span>(<span class="st">"liftr"</span>)</code></pre></div>
- <p>Or try the development version on GitHub:</p>
- <div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="co"># install.packages("devtools")</span>
- devtools<span class="op">::</span><span class="kw"><a href="http://www.rdocumentation.org/packages/devtools/topics/install_github">install_github</a></span>(<span class="st">"road2stat/liftr"</span>)</code></pre></div>
- <p><a href="https://liftr.me/articles/">Browse the vignettes</a> or the <a href="https://vimeo.com/212815497">demo video</a> for a quick-start.</p>
- </div>
- <div id="workflow" class="section level2">
- <h2 class="hasAnchor">
- <a href="#workflow" class="anchor"></a>Workflow</h2>
- <p><img src="https://i.imgur.com/AKveypK.png" width="100%" alt="Containerize R Markdown Documents with liftr"></p>
- </div>
- <div id="events" class="section level2">
- <h2 class="hasAnchor">
- <a href="#events" class="anchor"></a>Events</h2>
- <table class="table">
- <colgroup>
- <col width="22%">
- <col width="32%">
- <col width="44%">
- </colgroup>
- <thead><tr class="header">
- <th align="left">Time</th>
- <th align="left">Event</th>
- <th align="left">Location</th>
- </tr></thead>
- <tbody>
- <tr class="odd">
- <td align="left">July 27, 2017</td>
- <td align="left">
- <a href="https://bioconductor.org/help/course-materials/2017/BioC2017/">BioC 2017</a> (<a href="https://nanx.me/posters/dockflow-poster-bioc2017.pdf">poster</a> for <a href="https://dockflow.org/">dockflow.org</a>)</td>
- <td align="left">Dana-Farber Cancer Institute, Boston, MA</td>
- </tr>
- <tr class="even">
- <td align="left">May 20, 2017</td>
- <td align="left">
- <a href="http://china-r.org/">The 10th China-R Conference</a> (talk)</td>
- <td align="left">Tsinghua University, Beijng, China</td>
- </tr>
- <tr class="odd">
- <td align="left">April 18, 2017</td>
- <td align="left">
- <a href="http://2017.dockercon.com/">DockerCon 2017</a> (<a href="https://nanx.me/talks/dockercon2017-liftr-nanxiao.pdf">talk</a>)</td>
- <td align="left">Austin Convention Center, Austin, TX</td>
- </tr>
- <tr class="even">
- <td align="left">December 3, 2015</td>
- <td align="left">
- <a href="http://learn.cri.uchicago.edu/2015-cri-bioinformatics-workshop/">CRI Bioinformatics Workshop</a> (talk)</td>
- <td align="left">The University of Chicago, Chicago, IL</td>
- </tr>
- <tr class="odd">
- <td align="left">July 21, 2015</td>
- <td align="left">
- <a href="https://bioconductor.org/help/course-materials/2015/BioC2015/">BioC 2015</a> (workshop)</td>
- <td align="left">Fred Hutchinson Cancer Research Center, Seattle, WA</td>
- </tr>
- </tbody>
- </table>
- </div>
- <div id="contribute" class="section level2">
- <h2 class="hasAnchor">
- <a href="#contribute" class="anchor"></a>Contribute</h2>
- <p>To contribute to this project, please take a look at the <a href="https://github.com/road2stat/liftr/blob/master/CONTRIBUTING.md">Contributing Guidelines</a> first. Please note that this project is released with a <a href="https://github.com/road2stat/liftr/blob/master/CONDUCT.md">Contributor Code of Conduct</a>. By participating in this project you agree to abide by its terms.</p>
- </div>
- <div id="license" class="section level2">
- <h2 class="hasAnchor">
- <a href="#license" class="anchor"></a>License</h2>
- <p>liftr is free and open source software, licensed under GPL-3.</p>
- </div>
- </div>
- </div>
- <div class="col-md-3" id="sidebar">
- <h2>Links</h2>
- <ul class="list-unstyled">
- <li>Download from CRAN at <br><a href="https://cran.r-project.org/package=liftr">https://cran.r-project.org/package=liftr</a>
- </li>
- <li>Browse source code at <br><a href="https://github.com/road2stat/liftr">https://github.com/road2stat/liftr</a>
- </li>
- <li>Report a bug at <br><a href="https://github.com/road2stat/liftr/issues">https://github.com/road2stat/liftr/issues</a>
- </li>
- </ul>
- <h2>License</h2>
- <p><a href="https://www.r-project.org/Licenses/GPL-3">GPL-3</a> | file <a href="LICENSE.html">LICENSE</a></p>
- <h2>Developers</h2>
- <ul class="list-unstyled">
- <li>Nan Xiao <br><small class="roles"> Author, maintainer </small> <br><small>(0000-0002-0250-5673)</small>
- </li>
- <li><a href="authors.html">All authors...</a></li>
- </ul>
- <h2>Dev status</h2>
- <ul class="list-unstyled">
- <li><a href="https://travis-ci.org/road2stat/liftr"><img src="https://travis-ci.org/road2stat/liftr.svg?branch=master" alt="Build Status"></a></li>
- <li><a href="https://ci.appveyor.com/project/road2stat/liftr"><img src="https://ci.appveyor.com/api/projects/status/github/road2stat/liftr?branch=master&svg=true" alt="AppVeyor Build Status"></a></li>
- <li><a href="https://cran.r-project.org/package=liftr"><img src="https://www.r-pkg.org/badges/version/liftr" alt="CRAN Version"></a></li>
- <li><a href="https://cran.r-project.org/package=liftr"><img src="https://cranlogs.r-pkg.org/badges/liftr" alt="Downloads from the RStudio CRAN mirror"></a></li>
- </ul>
- </div>
- </div>
- <footer><div class="copyright">
- <p>Developed by Nan Xiao.</p>
- </div>
- <div class="pkgdown">
- <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
- </div>
- </footer>
- </div>
- </body>
- </html>
|