resmush_clean_dir: Helper function for cleaning files created by 'resmush'

View source: R/resmush_clean_dir.R

resmush_clean_dirR Documentation

Helper function for cleaning files created by resmush

Description

Use with caution. This would remove files from your computer.

Clean a directory (or a list of directories) of files created by resmush_file().

Usage

resmush_clean_dir(dir, suffix = "_resmush", recursive = FALSE)

Arguments

dir

A character vector of full path names. See list.files(), path argument.

suffix

Character, defaults to "_resmush". See resmush_file().

recursive

Logical. Should the file search recurse into directories?

Value

An invisible() NULL value. Produces messages with information about the process.

See Also

resmush_file(), resmush_dir(), list.files(), unlink()

Examples



# Simple example

png_file <- system.file("extimg/example.png", package = "resmush")

# Copy to a temporary file with a given suffix
suffix <- "_would_be_removed"
tmp_png <- file.path(
  tempdir(),
  paste0("example", suffix, ".png")
)

file.exists(tmp_png)
file.copy(png_file, tmp_png, overwrite = TRUE)

file.exists(tmp_png)

# This won't remove it
resmush_clean_dir(tempdir())

file.exists(tmp_png)

# Need suffix
resmush_clean_dir(tempdir(), suffix = suffix)

file.exists(tmp_png)



resmush documentation built on March 14, 2026, 5:06 p.m.