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

# validatesuggest

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/validatesuggest)](https://CRAN.R-project.org/package=validatesuggest)
[![R-CMD-check](https://github.com/data-cleaning/validatesuggest/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/data-cleaning/validatesuggest/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of validatesuggest is to generate suggestions for [validation](https://CRAN.R-project.org/package=validate) rules from a supplied 
dataset. These can be used as a starting point for a rule set and are to be
adjusted by domain experts.

## Installation

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("data-cleaning/validatesuggest")
```
## Example

```{r example}
library(validate)
library(validatesuggest)

data(retailers, package="validate")
data(SBS2000, package="validate")

# does all
#suggest_rules(retailers)

suggest_pos_check(retailers)

suggest_range_check(retailers, min=TRUE, max=TRUE)

suggest_na_check(retailers)

suggest_unique_check(SBS2000)

suggest_type_check(retailers)

suggest_ratio_check(retailers)

write_cond_rule(car_owner)
```