index.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. <!-- Generated by pkgdown: do not edit by hand -->
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  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>Function reference • liftr</title>
  9. <!-- jquery -->
  10. <script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
  11. <!-- Bootstrap -->
  12. <link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
  13. <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
  14. <!-- Font Awesome icons -->
  15. <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">
  16. <!-- pkgdown -->
  17. <link href="../pkgdown.css" rel="stylesheet">
  18. <script src="../jquery.sticky-kit.min.js"></script>
  19. <script src="../pkgdown.js"></script>
  20. <!-- mathjax -->
  21. <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
  22. <!--[if lt IE 9]>
  23. <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
  24. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  25. <![endif]-->
  26. <!-- Google analytics -->
  27. <script>
  28. (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  29. (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  30. m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  31. })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
  32. ga('create', 'UA-65001771-1', 'auto');
  33. ga('send', 'pageview');
  34. </script>
  35. </head>
  36. <body>
  37. <div class="container template-reference-index">
  38. <header>
  39. <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  40. <div class="container">
  41. <div class="navbar-header">
  42. <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
  43. <span class="icon-bar"></span>
  44. <span class="icon-bar"></span>
  45. <span class="icon-bar"></span>
  46. </button>
  47. <a class="navbar-brand" href="../index.html">liftr</a>
  48. </div>
  49. <div id="navbar" class="navbar-collapse collapse">
  50. <ul class="nav navbar-nav">
  51. <li>
  52. <a href="../index.html">
  53. <span class="fa fa-home fa-lg"></span>
  54. </a>
  55. </li>
  56. <li>
  57. <a href="../reference/index.html">Reference</a>
  58. </li>
  59. <li class="dropdown">
  60. <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
  61. Articles
  62. <span class="caret"></span>
  63. </a>
  64. <ul class="dropdown-menu" role="menu">
  65. <li>
  66. <a href="../articles/liftr-addins.html">RStudio Addins for liftr</a>
  67. </li>
  68. <li>
  69. <a href="../articles/liftr-intro.html">A Quick Introduction to liftr</a>
  70. </li>
  71. <li>
  72. <a href="../articles/liftr-tidyverse.html">Explore tidyverse with liftr</a>
  73. </li>
  74. </ul>
  75. </li>
  76. <li>
  77. <a href="../news/index.html">News</a>
  78. </li>
  79. </ul>
  80. <ul class="nav navbar-nav navbar-right">
  81. <li>
  82. <a href="https://github.com/road2stat/liftr">
  83. <span class="fa fa-github fa-lg"></span>
  84. </a>
  85. </li>
  86. </ul>
  87. </div><!--/.nav-collapse -->
  88. </div><!--/.container -->
  89. </div><!--/.navbar -->
  90. </header>
  91. <div class="row">
  92. <div class="col-md-9">
  93. <div class="page-header">
  94. <h1>
  95. Reference
  96. <small>version&nbsp;0.8</small>
  97. </h1>
  98. </div>
  99. <div class="contents">
  100. <table class="ref-index">
  101. <colgroup>
  102. <col class="alias" />
  103. <col class="title" />
  104. </colgroup>
  105. <tbody>
  106. <tr>
  107. <th colspan="2">
  108. <h2 id="section-docker-installation" class="hasAnchor"><a href="#section-docker-installation" class="anchor"></a>Docker Installation</h2>
  109. <p class="section-desc"><p>Functions for guiding Docker installation and checking Docker status.</p></p>
  110. </th>
  111. </tr>
  112. <tr>
  113. <!-- -->
  114. <td>
  115. <p><code><a href="install_docker.html">install_docker</a></code> </p>
  116. </td>
  117. <td><p>Installation Helper for Docker Engine</p></td>
  118. </tr><tr>
  119. <!-- -->
  120. <td>
  121. <p><code><a href="check_docker_install.html">check_docker_install</a></code> </p>
  122. </td>
  123. <td><p>Check if Docker was Installed</p></td>
  124. </tr><tr>
  125. <!-- -->
  126. <td>
  127. <p><code><a href="check_docker_running.html">check_docker_running</a></code> </p>
  128. </td>
  129. <td><p>Check if Docker Daemon is Running</p></td>
  130. </tr>
  131. </tbody><tbody>
  132. <tr>
  133. <th colspan="2">
  134. <h2 id="section-containerization-and-rendering" class="hasAnchor"><a href="#section-containerization-and-rendering" class="anchor"></a>Containerization and Rendering</h2>
  135. <p class="section-desc"><p>Functions for containerizing and rendering R Markdown documents.</p></p>
  136. </th>
  137. </tr>
  138. <tr>
  139. <!-- -->
  140. <td>
  141. <p><code><a href="lift.html">lift</a></code> </p>
  142. </td>
  143. <td><p>Containerize R Markdown Documents</p></td>
  144. </tr><tr>
  145. <!-- -->
  146. <td>
  147. <p><code><a href="render_docker.html">render_docker</a></code> <code><a href="render_docker.html">drender</a></code> </p>
  148. </td>
  149. <td><p>Render Containerized R Markdown Documents</p></td>
  150. </tr><tr>
  151. <!-- -->
  152. <td>
  153. <p><code><a href="liftr-package.html">liftr-package</a></code> </p>
  154. </td>
  155. <td><p>Containerize R Markdown Documents</p></td>
  156. </tr>
  157. </tbody><tbody>
  158. <tr>
  159. <th colspan="2">
  160. <h2 id="section-docker-housekeeping" class="hasAnchor"><a href="#section-docker-housekeeping" class="anchor"></a>Docker Housekeeping</h2>
  161. <p class="section-desc"><p>Functions for cleaning up dangling or existing containers and images“.</p></p>
  162. </th>
  163. </tr>
  164. <tr>
  165. <!-- -->
  166. <td>
  167. <p><code><a href="prune_container.html">prune_container</a></code> <code><a href="prune_container.html">purge_container</a></code> </p>
  168. </td>
  169. <td><p>Remove Specific Docker Containers</p></td>
  170. </tr><tr>
  171. <!-- -->
  172. <td>
  173. <p><code><a href="prune_image.html">prune_image</a></code> <code><a href="prune_image.html">purge_image</a></code> </p>
  174. </td>
  175. <td><p>Remove Specific Docker Images</p></td>
  176. </tr><tr>
  177. <!-- -->
  178. <td>
  179. <p><code><a href="prune_container_auto.html">prune_container_auto</a></code> </p>
  180. </td>
  181. <td><p>Remove Dangling Docker Containers</p></td>
  182. </tr><tr>
  183. <!-- -->
  184. <td>
  185. <p><code><a href="prune_image_auto.html">prune_image_auto</a></code> </p>
  186. </td>
  187. <td><p>Remove Dangling Docker Images</p></td>
  188. </tr><tr>
  189. <!-- -->
  190. <td>
  191. <p><code><a href="prune_all_auto.html">prune_all_auto</a></code> </p>
  192. </td>
  193. <td><p>Remove Docker Containers, Images, and Networks</p></td>
  194. </tr>
  195. </tbody>
  196. </table>
  197. </div>
  198. </div>
  199. <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
  200. <h2>Contents</h2>
  201. <ul class="nav nav-pills nav-stacked">
  202. <li><a href="#section-docker-installation">Docker Installation</a></li>
  203. <li><a href="#section-containerization-and-rendering">Containerization and Rendering</a></li>
  204. <li><a href="#section-docker-housekeeping">Docker Housekeeping</a></li>
  205. </ul>
  206. </div>
  207. </div>
  208. <footer>
  209. <div class="copyright">
  210. <p>Developed by Nan Xiao.</p>
  211. </div>
  212. <div class="pkgdown">
  213. <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
  214. </div>
  215. </footer>
  216. </div>
  217. </body>
  218. </html>