prune_container.Rd 771 B

123456789101112131415161718192021222324252627282930
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/prune.R
  3. \name{prune_container}
  4. \alias{prune_container}
  5. \alias{purge_container}
  6. \title{Remove Specific Docker Containers}
  7. \usage{
  8. prune_container(input_yml)
  9. purge_container()
  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 Docker
  14. container to be stopped and removed. If not specified, will prune all
  15. dangling containers.}
  16. }
  17. \value{
  18. prune results
  19. }
  20. \description{
  21. This function stops and removes the Docker containers 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_container()}
  28. }