README.md

In UBC-MDS/rimager: Process images

rimager

Overview

Want to edit an image in the shell instead of GUI applications? rimager is a R package that provides a quick and easy way to do some simple image processing and graphic editing. Based on the main needs of graphic editing, the package integrates four functionalities. The functionalities include: reducing the size of an image, cropping an image into a circle, reducing the number of colours in an image, and applying cool filter effects. By inputting the path of the image, users can run any of these functions with one line of code to get the desired image. This package was developed as a course project for DSCI-524 at the University of British Columbia.

To learn more about rimager and how to use it, please visit the package website.

Creators

| Name | GitHub | | ------------------- | --------------------------------------- | | Keanna Knebel | Keanna-K | | Mohammed Salama | dataubc | | Zhengyang (Zoe) Pan | zoepan00 | | Haoyu (Clara) Su | clsu22 |

To contribute to this project, you must adhere to the terms outlined in our Code of Conduct.

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("UBC-MDS/rimager")

Dependencies

• R 3.6.1 or greater
  • magick
  • plotrix
  • jpeg
  • OpenImageR

Note: Because some operating systems (Ubuntu-16.04 ‘3.2’, ‘3.3’ ‘3.4’ and macOs-devel) require older versions of packages (magick and plotrix) we used in development, we have excluded these OS in R-CMD-check.

Functions

• circropper: This function crops the input image into a circle. This can be useful when you want to make icons from images.
• redusize: This function reduces the dimension of a given image by removing vertical and horizontal seams.
• imgfilter: This function applies a filter to a given image, altering the visual aesthetic. This includes options to blur and sharpen the image with varying degrees of strength. This filter effect is achieved through the application of a matrix convolution with the filter kernel and original image.
• reducolor: This function reduces the image colors to get the cartoonized color effect. This can be either white and black images or eight colors images.

Usage Examples

see rimager-Vignette

Our Package in the R Ecosystem

There are existing packages to process images. For example, both magick and imager are popular packages that can be used to resize, cut images and apply filters. The goal of our package is to utilize these existing packages to improve the pre-existing functions or to re-implement the code manually. Additionally, it automates the image editing process, producing the altered image by one line of code.

Package in python

We have a package with the same functionalities in python: pyimager

Documentation

The official documentation is hosted on pkgdown. You can also refer to the html vignette.

UBC-MDS/rimager documentation built on April 1, 2020, 4:36 a.m.