/
README.Rmd
56 lines (37 loc) · 3.44 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE, comment = "#>", fig.path = "man/figures/README-",
message = FALSE, warning = FALSE, error = FALSE
)
```
# memery <img src="man/figures/logo.png" style="margin-left:10px;margin-bottom:5px;" width="120" align="right">
[](https://www.repostatus.org/)
[](https://cran.r-project.org/package=memery)
[](https://cran.r-project.org/package=memery)
[](https://github.com/leonawicz/memery)
## Make memorable plots with `memery`.
The `memery` package generates internet memes that optionally include a superimposed inset plot and other atypical features, combining the visual impact of an attention-grabbing meme with graphic results of data analysis.
The package differs from related packages that focus on imitating and reproducing standard memes. Some packages do this by interfacing with online meme generators whereas others achieve this natively. This package takes the latter approach. It does not interface with online meme generators or require any authentication with external websites. It reads images directly from local files or via URL and meme generation is done by the package.
While this is similar to the `meme` package available on CRAN, it differs in that the focus is on allowing for non-standard meme layouts and hybrids of memes mixed with graphs. While this package can be used to make basic memes like an online meme generator would produce, it caters primarily to hybrid graph-meme plots where the meme presentation can be seen as a backdrop highlighting foreground graphs of data analysis results.
The package also provides support for an arbitrary number of meme text labels with arbitrary size, position and other attributes rather than restricting to the standard top and/or bottom text placement. This is useful for proper aesthetic interleaving of plots of data between meme image backgrounds and overlain text labels. The package offers a selection of templates for graph placement and appearance with respect to the underlying meme. Graph templates also permit additional template-specific customization.
Animated gif support is provided but this is optional and functional only if the `magick` package is installed.
## Installation
Install the CRAN release of `memery` with
```r
install.packages("memery")
```
Install the development version from GitHub with
```r
# install.packages("remotes")
remotes::install_github("leonawicz/memery")
```
See the [vignette](https://leonawicz.github.io/memery/articles/memery.html) for an overview with usage examples.
## Contribute
Contributions are welcome. Contribute through GitHub via pull request. Please create an issue first if it is regarding any substantive feature add or change.
---
Please note that the `memery` project is released with a [Contributor Code of Conduct](https://github.com/leonawicz/memery/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.