index.Rmd

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

# goodpractice <img src="man/figures/logo.png" align="right" width="20%" height="20%" />

[![Linux Build Status](https://travis-ci.org/MangoTheCat/goodpractice.svg?branch=master)](https://travis-ci.org/MangoTheCat/goodpractice)
[![Windows Build status](https://ci.appveyor.com/api/projects/status/github/MangoTheCat/goodpractice?svg=true)](https://ci.appveyor.com/project/gaborcsardi/goodpractice)
[![](https://www.r-pkg.org/badges/version/goodpractice)](https://www.r-pkg.org/pkg/goodpractice)
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/goodpractice)](https://www.r-pkg.org/pkg/goodpractice)
[![Coverage Status](https://img.shields.io/codecov/c/github/MangoTheCat/goodpractice/master.svg)](https://codecov.io/github/MangoTheCat/goodpractice?branch=master)

## Advice on R Package Building

Give advice about good practices when building R packages. Advice includes
functions and syntax to avoid, package structure, code complexity, code
formatting, etc.

## Installation

You can install the release version from CRAN

```{r eval = FALSE}
install.packages("goodpractice")
```

and the development version from GitHub 

```{r eval = FALSE}
source("https://install-github.me/MangoTheCat/goodpractice")
# or
# install.packages("devtools")
devtools::install_github("mangothecat/goodpractice") 
```

## Usage

```r
library(goodpractice)
gp("<my-package>")
```

## License

MIT © Mango Solutions