Package {resmush}

Title:	Optimize and Compress Image Files with 'reSmush.it'
Version:	1.0.1
Description:	Optimize and compress local image files, directories and online images with the 'reSmush.it' API https://resmush.it/. Supports 'png', 'jpg/jpeg', 'gif', 'bmp' and 'tiff' files.
License:	MIT + file LICENSE
URL:	https://dieghernan.github.io/resmush/, https://github.com/dieghernan/resmush
BugReports:	https://github.com/dieghernan/resmush/issues
Depends:	R (≥ 4.1.0)
Imports:	cli, curl, httr2 (≥ 1.0.0), tools, utils
Suggests:	grid, knitr, png, quarto, rmarkdown, testthat (≥ 3.0.0)
VignetteBuilder:	quarto
Config/Needs/website:	dieghernan/gitdevr, xfun, dplyr, tibble, devtools, remotes, pak
Config/roxygen2/markdown:	TRUE
Config/roxygen2/version:	8.0.0
Config/testthat/edition:	3
Config/testthat/parallel:	true
Encoding:	UTF-8
X-schema.org-keywords:	r, compress-images, optimize-images, resmushit, api, r-package, cran, cran-r
NeedsCompilation:	no
Packaged:	2026-05-29 10:29:42 UTC; diego
Author:	Diego Hernangómez [aut, cre, cph]
Maintainer:	Diego Hernangómez <diego.hernangomezherrero@gmail.com>
Repository:	CRAN
Date/Publication:	2026-05-29 10:50:02 UTC

resmush: Optimize and Compress Image Files with 'reSmush.it'

Description

Optimize and compress local image files, directories and online images with the 'reSmush.it' API https://resmush.it/. Supports 'png', 'jpg/jpeg', 'gif', 'bmp' and 'tiff' files.

Author(s)

Maintainer: Diego Hernangómez diego.hernangomezherrero@gmail.com (ORCID) [copyright holder]

Authors:

• Diego Hernangómez diego.hernangomezherrero@gmail.com (ORCID) [copyright holder]

See Also

Useful links:

• https://dieghernan.github.io/resmush/

• https://github.com/dieghernan/resmush

• Report bugs at https://github.com/dieghernan/resmush/issues

Clean files created by resmush

Description

Use with caution. This removes files from your computer. Clean one or more directories of files created by resmush_file().

Usage

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

Arguments

Value

Returns an invisible() NULL value and produces messages summarizing 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)

# Run with the default suffix. This should not remove the file.
resmush_clean_dir(tempdir())

file.exists(tmp_png)

# Use the matching suffix to remove the file.
resmush_clean_dir(tempdir(), suffix = suffix)

file.exists(tmp_png)

Optimize image files in directories

Description

Optimize supported image files in one or more directories with the reSmush.it API.

Usage

resmush_dir(
  dir,
  ext = "\\.(png|jpe?g|bmp|gif|tif)$",
  suffix = "_resmush",
  overwrite = FALSE,
  progress = TRUE,
  report = TRUE,
  recursive = FALSE,
  ...
)

Arguments

Value

Writes optimized files to disk when the API call is successful. Invisibly returns a data frame summarizing the process.

See Also

reSmush.it API documentation.

See resmush_clean_dir() to clean a directory of previous runs.

Other functions for optimizing: resmush_file(), resmush_url()

Examples

# Copy the example directory.
example_dir <- system.file("extimg", package = "resmush")
temp_dir <- tempdir()
file.copy(example_dir, temp_dir, recursive = TRUE)

# Create the destination folder path.
dest_folder <- file.path(tempdir(), "extimg")

# Non-recursive.
resmush_dir(dest_folder)
resmush_clean_dir(dest_folder)

# Recursive.
summary <- resmush_dir(dest_folder, recursive = TRUE)

# Return the same information in the invisible data frame.
summary[, -c(1, 2)]

# Display the `png` output.
if (require("png", quietly = TRUE)) {
  a_png <- grepl("png$", summary$dest_img)
  my_png <- png::readPNG(summary[a_png, ]$dest_img[2])
  grid::grid.raster(my_png)
}

# Clean up the example files.
unlink(dest_folder, force = TRUE, recursive = TRUE)

Optimize local image files

Description

Optimize one or more local image files with the reSmush.it API.

Usage

resmush_file(
  file,
  suffix = "_resmush",
  overwrite = FALSE,
  progress = TRUE,
  report = TRUE,
  qlty = 92,
  exif_preserve = FALSE
)

Arguments

Value

Writes optimized files to disk when the API call is successful. Invisibly returns a data frame summarizing the process. With report = TRUE, a summary report is also displayed in the console.

See Also

reSmush.it API documentation.

See resmush_clean_dir() to clean a directory of previous runs.

Other functions for optimizing: resmush_dir(), resmush_url()

Examples

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

# Copy to a temporary file for this example.
tmp_png <- tempfile(fileext = ".png")

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

resmush_file(tmp_png)

# Several paths.
jpg_file <- system.file("extimg/example.jpg", package = "resmush")
tmp_jpg <- tempfile(fileext = ".jpg")

file.copy(jpg_file, tmp_jpg, overwrite = TRUE)

# Display a summary in the console.
summary <- resmush_file(c(tmp_png, tmp_jpg))

# The invisible data frame contains the same information.
summary

# Display the `png` output.
if (require("png", quietly = TRUE)) {
  my_png <- png::readPNG(summary$dest_img[1])
  grid::grid.raster(my_png)
}

# Use with `jpg` files and parameters.
resmush_file(tmp_jpg)
resmush_file(tmp_jpg, qlty = 10)

Optimize online image files

Description

Optimize and download one or more online image files with the reSmush.it API.

Usage

resmush_url(
  url,
  outfile = file.path(tempdir(), basename(url)),
  overwrite = FALSE,
  progress = TRUE,
  report = TRUE,
  qlty = 92,
  exif_preserve = FALSE
)

Arguments

Value

Writes optimized files to disk when the API call is successful. Invisibly returns a data frame summarizing the process. If any value in outfile is duplicated, resmush_url() renames the outputs with suffixes such as ⁠_01⁠ and ⁠_02⁠.

See Also

reSmush.it API documentation.

Other functions for optimizing: resmush_dir(), resmush_file()

Examples

# Base URL.
base_url <- "https://raw.githubusercontent.com/dieghernan/resmush/main/inst/"

png_url <- paste0(base_url, "/extimg/example.png")
resmush_url(png_url)

# Several URLs.
jpg_url <- paste0(base_url, "/extimg/example.jpg")

summary <- resmush_url(c(png_url, jpg_url))

# The invisible data frame contains a summary of the process.
summary

# Display the `png` output.
if (require("png", quietly = TRUE)) {
  my_png <- png::readPNG(summary$dest_img[1])
  grid::grid.raster(my_png)
}

# Use with `jpg` files and parameters.
resmush_url(jpg_url)
resmush_url(jpg_url, qlty = 10)