purge_all.html 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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>Purge Everything (Container + Image) — purge_all • 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/lumen/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://cdn.mathjax.org/mathjax/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-topic">
  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="../reference/index.html">Reference</a>
  53. </li>
  54. <li>
  55. <a href="../articles/index.html">Articles</a>
  56. </li>
  57. <li>
  58. <a href="../news/index.html">News</a>
  59. </li>
  60. </ul>
  61. <ul class="nav navbar-nav navbar-right">
  62. <li>
  63. <a href="https://github.com/road2stat/liftr">
  64. <span class="fa fa-github fa-lg"></span>
  65. </a>
  66. </li>
  67. </ul>
  68. </div><!--/.nav-collapse -->
  69. </div><!--/.container -->
  70. </div><!--/.navbar -->
  71. </header>
  72. <div class="row">
  73. <div class="col-md-9 contents">
  74. <div class="page-header">
  75. <h1>Purge Everything (Container + Image)</h1>
  76. </div>
  77. <p>This function will try to purge the Docker container
  78. and Docker image used for rendering the R Markdown document.</p>
  79. <pre><span class='fu'>purge_all</span>(<span class='no'>container_name</span>, <span class='no'>image_name</span>)</pre>
  80. <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
  81. <table class="ref-arguments">
  82. <colgroup><col class="name" /><col class="desc" /></colgroup>
  83. <tr>
  84. <th>container_name</th>
  85. <td><p>Name of the container to be stopped and removed.</p></td>
  86. </tr>
  87. <tr>
  88. <th>image_name</th>
  89. <td><p>Name of the image to be removed.</p></td>
  90. </tr>
  91. </table>
  92. <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
  93. <p>status</p>
  94. <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
  95. <pre class="examples"><div class='input'><span class='co'>## Not run: ------------------------------------</span>
  96. <span class='co'># purge_all("liftr_container_uuid", "report")</span>
  97. <span class='co'>## ---------------------------------------------</span></div></pre>
  98. </div>
  99. <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
  100. <h2>Contents</h2>
  101. <ul class="nav nav-pills nav-stacked">
  102. <li><a href="#arguments">Arguments</a></li>
  103. <li><a href="#value">Value</a></li>
  104. <li><a href="#examples">Examples</a></li>
  105. </ul>
  106. </div>
  107. </div>
  108. <footer>
  109. <div class="copyright">
  110. <p>Developed by Nan Xiao.</p>
  111. </div>
  112. <div class="pkgdown">
  113. <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
  114. </div>
  115. </footer>
  116. </div>
  117. </body>
  118. </html>