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

# datacheck

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

The goal of datacheck is to scans datasets for potential sensitive information that could be considered privacy violations according to data protection laws (e.g., GDPR, HIPAA). This is a tool to help screen datasets that researchers may want to openly share online. It can also be used as a research tool to scan datasets for potential privacy violations. 

The dataset itself is scanned in the R environment and is not sent to  any remote server; it happens 100% with the package and on the person's device.


## Installation

You can install the development version of datacheck from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("libscie/datacheck")
```