prune_image.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  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>Remove Specific Docker Images — prune_image • 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-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="../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 contents">
  93. <div class="page-header">
  94. <h1>Remove Specific Docker Images</h1>
  95. </div>
  96. <p>This function removes the Docker images used
  97. for rendering the R Markdown document based on the output
  98. YAML file from the (possibly unsuccessful) rendering process.</p>
  99. <pre class="usage"><span class='fu'>prune_image</span>(<span class='no'>input_yml</span>)
  100. <span class='fu'>purge_image</span>()</pre>
  101. <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
  102. <table class="ref-arguments">
  103. <colgroup><col class="name" /><col class="desc" /></colgroup>
  104. <tr>
  105. <th>input_yml</th>
  106. <td><p>The YAML file path (output of <code><a href='render_docker.html'>render_docker</a></code>)
  107. when <code>prune_info = TRUE</code> which stores the information of the
  108. Docker image to be removed. If not specified, will prune all
  109. dangling images.</p></td>
  110. </tr>
  111. </table>
  112. <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
  113. <p>prune results</p>
  114. <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
  115. <pre class="examples"><span class='co'># NOT RUN {</span>
  116. <span class='fu'>prune_image</span>()
  117. <span class='co'># }</span></pre>
  118. </div>
  119. <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
  120. <h2>Contents</h2>
  121. <ul class="nav nav-pills nav-stacked">
  122. <li><a href="#arguments">Arguments</a></li>
  123. <li><a href="#value">Value</a></li>
  124. <li><a href="#examples">Examples</a></li>
  125. </ul>
  126. </div>
  127. </div>
  128. <footer>
  129. <div class="copyright">
  130. <p>Developed by Nan Xiao.</p>
  131. </div>
  132. <div class="pkgdown">
  133. <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
  134. </div>
  135. </footer>
  136. </div>
  137. </body>
  138. </html>