index.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. <!DOCTYPE html>
  2. <!-- Generated by pkgdown: do not edit by hand --><html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>Containerize R Markdown Documents • liftr</title>
  9. <!-- 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">
  10. <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">
  11. <!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
  12. <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]>
  13. <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
  14. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  15. <![endif]--><!-- Google analytics --><script>
  16. (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  17. (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  18. m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  19. })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
  20. ga('create', 'UA-65001771-1', 'auto');
  21. ga('send', 'pageview');
  22. </script>
  23. </head>
  24. <body>
  25. <div class="container template-home">
  26. <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="index.html">liftr</a>
  35. </div>
  36. <div id="navbar" class="navbar-collapse collapse">
  37. <ul class="nav navbar-nav">
  38. <li>
  39. <a href="index.html">
  40. <span class="fa fa-home fa-lg"></span>
  41. </a>
  42. </li>
  43. <li>
  44. <a href="reference/index.html">Reference</a>
  45. </li>
  46. <li class="dropdown">
  47. <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
  48. Articles
  49. <span class="caret"></span>
  50. </a>
  51. <ul class="dropdown-menu" role="menu">
  52. <li>
  53. <a href="articles/liftr-addins.html">RStudio Addins for liftr</a>
  54. </li>
  55. <li>
  56. <a href="articles/liftr-intro.html">A Quick Introduction to liftr</a>
  57. </li>
  58. <li>
  59. <a href="articles/liftr-tidyverse.html">Explore tidyverse with liftr</a>
  60. </li>
  61. </ul>
  62. </li>
  63. <li>
  64. <a href="news/index.html">News</a>
  65. </li>
  66. </ul>
  67. <ul class="nav navbar-nav navbar-right">
  68. <li>
  69. <a href="https://github.com/road2stat/liftr">
  70. <span class="fa fa-github fa-lg"></span>
  71. </a>
  72. </li>
  73. </ul>
  74. </div>
  75. <!--/.nav-collapse -->
  76. </div>
  77. <!--/.container -->
  78. </div>
  79. <!--/.navbar -->
  80. </header><div class="row">
  81. <div class="contents col-md-9">
  82. <div id="liftr" class="section level1">
  83. <div class="page-header"><h1 class="hasAnchor">
  84. <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>
  85. </h1></div>
  86. <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>
  87. <div id="installation" class="section level2">
  88. <h2 class="hasAnchor">
  89. <a href="#installation" class="anchor"></a>Installation</h2>
  90. <p>Install liftr from CRAN:</p>
  91. <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>
  92. <p>Or try the development version on GitHub:</p>
  93. <div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="co"># install.packages("devtools")</span>
  94. 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>
  95. <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>
  96. </div>
  97. <div id="workflow" class="section level2">
  98. <h2 class="hasAnchor">
  99. <a href="#workflow" class="anchor"></a>Workflow</h2>
  100. <p><img src="https://i.imgur.com/AKveypK.png" width="100%" alt="Containerize R Markdown Documents with liftr"></p>
  101. </div>
  102. <div id="events" class="section level2">
  103. <h2 class="hasAnchor">
  104. <a href="#events" class="anchor"></a>Events</h2>
  105. <table class="table">
  106. <colgroup>
  107. <col width="22%">
  108. <col width="32%">
  109. <col width="44%">
  110. </colgroup>
  111. <thead><tr class="header">
  112. <th align="left">Time</th>
  113. <th align="left">Event</th>
  114. <th align="left">Location</th>
  115. </tr></thead>
  116. <tbody>
  117. <tr class="odd">
  118. <td align="left">July 27, 2017</td>
  119. <td align="left">
  120. <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>
  121. <td align="left">Dana-Farber Cancer Institute, Boston, MA</td>
  122. </tr>
  123. <tr class="even">
  124. <td align="left">May 20, 2017</td>
  125. <td align="left">
  126. <a href="http://china-r.org/">The 10th China-R Conference</a> (talk)</td>
  127. <td align="left">Tsinghua University, Beijng, China</td>
  128. </tr>
  129. <tr class="odd">
  130. <td align="left">April 18, 2017</td>
  131. <td align="left">
  132. <a href="http://2017.dockercon.com/">DockerCon 2017</a> (<a href="https://nanx.me/talks/dockercon2017-liftr-nanxiao.pdf">talk</a>)</td>
  133. <td align="left">Austin Convention Center, Austin, TX</td>
  134. </tr>
  135. <tr class="even">
  136. <td align="left">December 3, 2015</td>
  137. <td align="left">
  138. <a href="http://learn.cri.uchicago.edu/2015-cri-bioinformatics-workshop/">CRI Bioinformatics Workshop</a> (talk)</td>
  139. <td align="left">The University of Chicago, Chicago, IL</td>
  140. </tr>
  141. <tr class="odd">
  142. <td align="left">July 21, 2015</td>
  143. <td align="left">
  144. <a href="https://bioconductor.org/help/course-materials/2015/BioC2015/">BioC 2015</a> (workshop)</td>
  145. <td align="left">Fred Hutchinson Cancer Research Center, Seattle, WA</td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. </div>
  150. <div id="contribute" class="section level2">
  151. <h2 class="hasAnchor">
  152. <a href="#contribute" class="anchor"></a>Contribute</h2>
  153. <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>
  154. </div>
  155. <div id="license" class="section level2">
  156. <h2 class="hasAnchor">
  157. <a href="#license" class="anchor"></a>License</h2>
  158. <p>liftr is free and open source software, licensed under GPL-3.</p>
  159. </div>
  160. </div>
  161. </div>
  162. <div class="col-md-3" id="sidebar">
  163. <h2>Links</h2>
  164. <ul class="list-unstyled">
  165. <li>Download from CRAN at <br><a href="https://cran.r-project.org/package=liftr">https://​cran.r-project.org/​package=liftr</a>
  166. </li>
  167. <li>Browse source code at <br><a href="https://github.com/road2stat/liftr">https://​github.com/​road2stat/​liftr</a>
  168. </li>
  169. <li>Report a bug at <br><a href="https://github.com/road2stat/liftr/issues">https://​github.com/​road2stat/​liftr/​issues</a>
  170. </li>
  171. </ul>
  172. <h2>License</h2>
  173. <p><a href="https://www.r-project.org/Licenses/GPL-3">GPL-3</a> | file <a href="LICENSE.html">LICENSE</a></p>
  174. <h2>Developers</h2>
  175. <ul class="list-unstyled">
  176. <li>Nan Xiao <br><small class="roles"> Author, maintainer </small> <br><small>(0000-0002-0250-5673)</small>
  177. </li>
  178. <li><a href="authors.html">All authors...</a></li>
  179. </ul>
  180. <h2>Dev status</h2>
  181. <ul class="list-unstyled">
  182. <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>
  183. <li><a href="https://ci.appveyor.com/project/road2stat/liftr"><img src="https://ci.appveyor.com/api/projects/status/github/road2stat/liftr?branch=master&amp;svg=true" alt="AppVeyor Build Status"></a></li>
  184. <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>
  185. <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>
  186. </ul>
  187. </div>
  188. </div>
  189. <footer><div class="copyright">
  190. <p>Developed by Nan Xiao.</p>
  191. </div>
  192. <div class="pkgdown">
  193. <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
  194. </div>
  195. </footer>
  196. </div>
  197. </body>
  198. </html>