README.Rmd

---
output: 
  md_document:
    variant: gfm
html_preview: false
---

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

# ggstar: star layer for ggplot2

```{r, echo=FALSE, results="hide", message=FALSE}
library(badger)
```

<img src="https://github.com/xiangpin/ggstar/blob/master/inst/extdata/ggstar.png" height="200" align="right" />

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/ggstar?color=green)](https://cran.r-project.org/package=ggstar)
<!-- r badge_devel("xiangpin/ggstar", "green") -->
[![](https://cranlogs.r-pkg.org/badges/grand-total/ggstar?color=green)](https://cran.r-project.org/package=ggstar)
[![](https://cranlogs.r-pkg.org/badges/ggstar?color=green)](https://cranlogs.r-pkg.org/downloads/total/last-month/ggstar)
[![](https://cranlogs.r-pkg.org/badges/last-week/ggstar?color=green)](https://cranlogs.r-pkg.org/downloads/total/last-week/ggstar)

```{r, comment="", echo=FALSE, results='asis'}
cat(packageDescription('ggstar')$Description)
```

# :writing_hand: Author

[Shuangbin Xu](https://github.com/xiangpin)

School of Basic Medical Sciences, Southern Medical University

# :arrow_double_down: Installation

Get the released version from `CRAN`:

```r
install.packages("ggstar")
```

Or the development version from `github`:

```r
if (!requireNamespace("devtools", quietly=TRUE))
    install.packages("devtools")
devtools::install_github("xiangpin/ggstar")
```

# :beginner: Usage

Total starshapes:

![](./inst/extdata/starshapes.png)

```{r, eval=FALSE, echo=FALSE}
library(ggplot2)
library(ggstar)
p <- ggplot(data=mtcars, 
            mapping=aes(x=wt, 
                        y=mpg, 
                        fill=cyl)) + 
     geom_star()
p
```

<!-- ![](./inst/extdata/figure1.png) -->

```{r, eval=FALSE, echo=FALSE}
p2 <- ggplot(data=iris, 
             mapping=aes(x=Sepal.Length, 
                         y=Sepal.Width, 
                         fill=Species)) +
     geom_star()
p2
```

<!-- ![](./inst/extdata/figure2.png) -->

```{r, eval=FALSE, echo=FALSE}
p3 <- ggplot(data=iris,
             mapping=aes(x=Sepal.Length,
                         y=Sepal.Width,
                         fill=Species,
                         starshape=Species)) +
      geom_star() + scale_starshape_manual(values=c(1, 2, 9))
p3
```

<!-- ![](./inst/extdata/figure3.png) -->

# :book: Vignette

For more details, please refer to the [online vignette](https://cran.r-project.org/web/packages/ggstar/vignettes/ggstar.html)

If you have installed it, you can also view the vignette on local.

```r
browseVignettes("ggstar")
```

# :sparkling_heart: Contributing

We welcome any contributions! By participating in this project you agree to abide
by the terms outlined in the [Contributor Code of Conduct](CONDUCT.md).