README.Rmd

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

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


# `aplot` for decorating a plot with associated information

`r badger::badge_license("Artistic-2.0")`
`r badger::badge_github_version("YuLab-SMU/aplot", "blue")`
`r badger::badge_code_size("YuLab-SMU/aplot")`
`r badger::badge_last_commit("YuLab-SMU/aplot", 'master')`
<br>
`r badger::badge_cran_release('aplot', 'green')`
`r badger::badge_cran_download('aplot', 'grand-total', 'green')`
`r badger::badge_github_actions("YuLab-SMU/aplot", action='rworkflows')`
`r badger::badge_codecov(ref='YuLab-SMU/aplot', branch='master')`


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


## :writing_hand: Authors

Guangchuang YU

School of Basic Medical Sciences, Southern Medical University

<https://yulab-smu.top>


## :arrow_double_down: Installation

Get the released version from CRAN:

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

Or the development version from github:

```r
## install.packages("remotes")
remotes::install_github("YuLab-SMU/aplot")
```


## :book: Vignette

For more details, please refer to the [online vignette](https://yulab-smu.top/aplot).