---
output: rmarkdown::github_document
editor_options: 
  chunk_output_type: inline
---
```{r pkg-knitr-opts, include=FALSE}
knitr::opts_chunk$set(collapse=TRUE, fig.retina=2, message=FALSE, warning=FALSE)
options(width=120)
```

[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/boxcutr.svg?branch=master)](https://travis-ci.org/hrbrmstr/boxcutr) 
[![Coverage Status](https://codecov.io/gh/hrbrmstr/boxcutr/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/boxcutr)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/boxcutr)](https://cran.r-project.org/package=boxcutr)

# boxcutr

## Description

## What's Inside The Tin

The following functions are implemented:

## Installation

```{r install-ex, eval=FALSE}
devtools::install_git("https://sr.ht.com/~hrbrmstr/boxcutr.git")
# or
devtools::install_git("https://gitlab.com/hrbrmstr/boxcutr.git")
# or (if you must)
devtools::install_github("hrbrmstr/boxcutr")
```

## Usage

```{r lib-ex}
library(boxcutr)

# current version
packageVersion("boxcutr")

```

## boxcutr Metrics

```{r cloc, echo=FALSE}
cloc::cloc_pkg_md()
```

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). 
By participating in this project you agree to abide by its terms.
