knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

Rgram

R build status R build status Codecov test coverage

The goal of Rgram is to make the image processing task easy and intuitive. With Rgram, users can rotate the image, convert it to greyscale, flip it in either a horizontal or vertical direction, and add padding to it (frame).

Installation

You can install the released version of Rgram from CRAN with:

install.packages("devtools")
devtools::install_github("Rgram")

Example

This is a basic example which shows you how to solve a common problem:

install.packages("devtools")
devtools::install_github("Rgram")
## basic example code

Documentation

The help file can be viewed by:

?padding
?flipping
?rotate
?greyscale

What is special about using README.Rmd instead of just README.md? You can include R chunks like so:

summary(cars)

You'll still need to render README.Rmd regularly, to keep README.md up-to-date.

You can also embed plots, for example:

plot(pressure)

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub!



UBC-MDS/Rgram documentation built on March 30, 2021, 12:02 p.m.