https://github.com/ardata-fr/minimage

https://github.com/ardata-fr/minimage

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ardata-fr/minimage
• Owner: ardata-fr
• License: other
• Created: 2021-02-26T18:25:48.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-21T16:47:17.000Z (over 3 years ago)
• Last Synced: 2024-08-13T07:13:38.260Z (8 months ago)
• Language: R
• Size: 27.3 KB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - ardata-fr/minimage - (R)

README

        
---

output: 

  github_document:

    df_print: kable

---

```{r, include = FALSE}

library(knitr)

opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# minimage

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![R-CMD-check](https://github.com/ardata-fr/minimage/workflows/R-CMD-check/badge.svg)](https://github.com/ardata-fr/minimage/actions)

The goal of minimage is to let users minify size images.

The main function allows to compress the images contained in a directory to another 

directory, optionally changing some compression parameters.

## Installation

You can install minimage from [GitHub](https://github.com/ardata-fr/minimage/) with:

``` r

# install.packages("devtools")

devtools::install_github("ardata-fr/minimage")

```

## Example

```{r include=FALSE}

file.copy(system.file(package = "minimage", "test-files"), to = ".", recursive = TRUE)

dir.create("test-new-files", recursive = TRUE)

```

```{r example}

library(minimage)

compress_images("test-files/", "test-new-files/", verbose = FALSE)

compress_images("test-files/", "test-new-files/", png_quality = "90-100", 

                verbose = FALSE, overwrite = TRUE)

```

```{r include=FALSE}

unlink("test-files", force = TRUE, recursive = TRUE)

unlink("test-new-files", force = TRUE, recursive = TRUE)

```