README.Rmd

---
output: github_document
---

# catplot: Capable And Tity Plot <img src="man/figures/logo.png" align="right" alt="" width="120" />

[![R-CMD-check](https://github.com/zerostwo/catplot/workflows/R-CMD-check/badge.svg)](https://github.com/zerostwo/catplot)
[![Codecov test coverage](https://codecov.io/gh/zerostwo/catplot/branch/main/graph/badge.svg)](https://app.codecov.io/gh/zerostwo/catplot?branch=main)
[![lifecycle](https://img.shields.io/badge/lifecycle-Experimental-important.svg)](https://lifecycle.r-lib.org/articles/stages.html)

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

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

## 🤪 Overview

`catplot` is a capable and tity data visualization tool and maintained by [Songqi Duan](https://songqi.online).

## 📦 Installation

Install the latest version from [GitHub](https://github.com/zerostwo/catplot) as follow:

```{r, eval = FALSE}
if (!require(devtools)) install.packages("devtools")
devtools::install_github("zerostwo/catplot")
```
## 🕹️ Usage

```{r iris, fig.width=8, fig.height=5, warning=FALSE}
library(catplot)
library(ggplot2)

data("iris")
p <- ggplot(
  data = iris,
  aes(
    x = Species,
    y = Sepal.Length
  )
) +
  geom_boxplot() +
  theme_cat(
    aspect_ratio = 1,
    show_panel_grid = "both",
    show_title = "y"
  )
p
```

## 🧩 Code of Conduct
  
Please note that the catplot project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.