README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
stopifnot(require(knitr))
options(width = 90)
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  dev = "png",
  dpi = 150,
  fig.asp = 0.8,
  fig.width = 5,
  out.width = "60%",
  fig.align = "center"
)
set.seed(127)
```



# ggsimplex <img src="man/figures/ggsimplex-hexsticker.png" width = 120 alt="ggsimplex Logo" align="right" style="padding-left:10px;background-color:white;"/>

<!-- badges: start -->
[![R-CMD-check](https://github.com/marvinschmitt/ggsimplex/workflows/R-CMD-check/badge.svg)](https://github.com/marvinschmitt/ggsimplex/actions)
[![Codecov test coverage](https://codecov.io/gh/marvinschmitt/ggsimplex/branch/main/graph/badge.svg)](https://app.codecov.io/gh/marvinschmitt/ggsimplex?branch=main)
<!-- badges: end -->

## Warning: Proceed with caution
You are using an untested initial demo of `{ggsimplex}`. Beware of unexpected behavior and bugs.

This [blog post](https://www.marvinschmitt.com/blog/ggsimplex-prerelease/) gives a brief rundown of the pre-release version of `{ggsimplex}` with some examples.

Bug reports and feature requests are always welcome at the GitHub Issues Page. All issue reports are appreciated and will be considered for the actual package release. Please do not expect them to be fixed anytime soon, though.

## Overview

The goal of `ggsimplex` is to provide a set of visualization utilities revolving around the simplex as its underlying canvas.
It is an extension to `ggplot2`.


## Installation

`ggsimplex` is currently under active pre-alpha development and not yet available on CRAN.
If you wish to install the development version, you can use `devtools`:

```{r, eval=FALSE}
# install.packages('devtools')
devtools::install_github('marvinschmitt/ggsimplex')
```