
<!-- README.md is generated from README.Rmd. Please edit that file -->

# inverseRegex

The inverseRegex package allows users to reverse engineer regular
expression patterns for R objects. Individual characters can be
categorised into digits, letters, punctuation or spaces and encoded into
run-lengths. This could be useful to summarise a dataset without viewing
all individual entries or to aid in data cleaning.

An overview of the package can be found on
[CRAN](https://CRAN.R-project.org/package=inverseRegex/vignettes/overview.html)
or in
[vignettes/overview.Rmd](https://github.com/rntq472/inverseRegex/blob/master/vignettes/Overview.Rmd).

## Installation

``` r
## Install from CRAN:
install.packages('inverseRegex')

## Install the development version from GitHub:
## install.packages("devtools")
devtools::install_github("rntq472/inverseRegex")
```
