From 4ddcd0e5f446624cc4fbea9fd0504d1581d20c2b Mon Sep 17 00:00:00 2001 From: Nan Xiao Date: Tue, 19 Dec 2023 10:28:36 -0500 Subject: [PATCH] Add badges and installation section --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 8594984..2cae6dc 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,26 @@ [![R-CMD-check](https://github.com/Merck/boxly/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Merck/boxly/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/Merck/boxly/branch/main/graph/badge.svg)](https://app.codecov.io/gh/Merck/boxly?branch=main) +[![CRAN status](https://www.r-pkg.org/badges/version/boxly)](https://cran.r-project.org/package=boxly) +[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/boxly)](https://cran.r-project.org/package=boxly) +## Installation + +The easiest way to get boxly is to install from CRAN: + +```r +install.packages("boxly") +``` + +Alternatively, to use a new feature or get a bug fix, +you can install the development version of boxly from GitHub: + +```r +# install.packages("remotes") +remotes::install_github("Merck/boxly") +``` + ## Overview The boxly package creates interactive box plots for clinical trial analysis & reporting.