README.Rmd

---
output: github_document
---

<!-- 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%"
)
```

pkgmin <img src="inst/figures/pkgmin.png" height="120" align="right"/>
=========================================================


<!-- badges: start -->
[![Travis build status](https://travis-ci.org/ahasverus/pkgmin.svg?branch=master)](https://travis-ci.org/ahasverus/pkgmin)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/ahasverus/pkgmin?branch=master&svg=true)](https://ci.appveyor.com/project/ahasverus/pkgmin)
[![Codecov test coverage](https://codecov.io/gh/ahasverus/pkgmin/branch/master/graph/badge.svg)](https://codecov.io/gh/ahasverus/pkgmin?branch=master)
[![Project Status: Stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![DOI](https://zenodo.org/badge/223958446.svg)](https://zenodo.org/badge/latestdoi/223958446)
<!-- badges: end -->

The goal of pkgmin is to show the structure of an R package.

## Installation

You can install the dev version of pkgmin from [GitHub](https://github.com/ahasverus/pkgmin) with:

```{r echo=TRUE, eval=FALSE}
devtools::install_github("ahasverus/pkgmin", build_vignettes = TRUE)
```

## Getting started

Browse the vignette for a complete example:

```{r echo=TRUE, eval=FALSE}
library(pkgmin)
vignette(topic = "pkgmin")
```

Enjoy !