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

# namer

<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/jumpingrivers/namer/workflows/R-CMD-check/badge.svg)](https://github.com/jumpingrivers/namer/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/namer)](https://CRAN.R-project.org/package=namer)
[![Codecov test coverage](https://codecov.io/gh/jumpingrivers/namer/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jumpingrivers/namer?branch=main)
[![R-CMD-check](https://github.com/jumpingrivers/namer/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jumpingrivers/namer/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

```{r child="man/rmdfragments/intro.Rmd"} 
```

[![Example of use](man/figures/screenshot.png)](https://github.com/lockedata/pres-datascience/pull/1/files/)

## Use

```{r child="man/rmdfragments/use.Rmd"} 
```


## Installation

Install {namer} from CRAN

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

Or get the dev version from this repo using:

``` r
remotes::install_github("jumpingrivers/namer")
```
## Code of Conduct

Please note that the namer project is released with a [Contributor Code of Conduct](https://jumpingrivers.github.io/namer/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.