Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aftonsteps/ggalignment

R package for creating D&D alignment charts
https://github.com/aftonsteps/ggalignment

Last synced: about 2 months ago
JSON representation

R package for creating D&D alignment charts

Awesome Lists containing this project

README

        

---
output: github_document
---

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

# ggalignment

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![R-CMD-check](https://github.com/aftonsteps/ggalignment/workflows/R-CMD-check/badge.svg)](https://github.com/aftonsteps/ggalignment/actions)

The goal of ggalignment is to do one thing -- create DnD-style alignment charts! These charts range from lawful to neutral to chaotic in one dimension, and good to neutral to evil in the other. Pictures or text can be placed in each of boxes to indicate the alignment.

## Installation

You can install the development version from [GitHub](https://github.com/aftonsteps/ggalignment) with:

```{r eval = FALSE}
# install.packages("devtools")
devtools::install_github("aftonsteps/ggalignment")
```

You can install the release version from [CRAN](https://CRAN.R-project.org/package=ggalignment) with:

```{r eval = FALSE}
install.packages("ggalignment")
```

## Example

This is a basic example which shows you how to use ggalignment:

```{r example-setup}
library(ggalignment)

# an example dataframe of cats!
align_cats <- example_cats()
```

```{r example-chart}
ggalignment(align_cats)
```