prune_image.Rd 709 B

123456789101112131415161718192021222324252627282930
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/prune.R
  3. \name{prune_image}
  4. \alias{prune_image}
  5. \alias{purge_image}
  6. \title{Remove Specific Docker Images}
  7. \usage{
  8. prune_image(input_yml)
  9. purge_image()
  10. }
  11. \arguments{
  12. \item{input_yml}{The YAML file path (output of \code{\link{render_docker}})
  13. when \code{prune_info = TRUE} which stores the information of the
  14. Docker image to be removed. If not specified, will prune all
  15. dangling images.}
  16. }
  17. \value{
  18. prune results
  19. }
  20. \description{
  21. This function removes the Docker images used
  22. for rendering the R Markdown document based on the output
  23. YAML file from the (possibly unsuccessful) rendering process.
  24. }
  25. \examples{
  26. \dontrun{
  27. prune_image()}
  28. }