In paulhendricks/detector: Detect Data Containing Personally Identifiable Information

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)

detector

detector makes detecting data containing Personally Identifiable Information (PII) quick, easy, and scalable. It provides high-level functions that can take vectors and data.frames and return important summary statistics in a convenient data.frame. Once complete, detector will be able to detect the following types of PII:

• Full name
• Home address
• E-mail address
• National identification number
• Passport number
• Social Security number
• IP address
• Vehicle registration plate number
• Driver's license number
• Credit card number
• Date of birth
• Birthplace
• Telephone number
• Latitude and longtiude

State of the Union

Complete!

• E-mail address
• Telephone number
• National identification number

Needs more work...

• Credit card number

Haven't even started :(

• Full name
• Date of birth
• Home address
• IP address
• Vehicle registration plate number
• Driver's license number
• Birthplace
• Latitude and longtiude

Installation

You can install the latest development version from CRAN:

install.packages("detector")
````

Or from GitHub with:

```R
if (packageVersion("devtools") < 1.6) {
  install.packages("devtools")
}
devtools::install_github("paulhendricks/detector")

If you encounter a clear bug, please file a minimal reproducible example on GitHub.

API

Generate data containing fake PII

library(dplyr, warn.conflicts = FALSE)
library(generator)
n <- 6
set.seed(1)
ashley_madison <- 
  data.frame(name = r_full_names(n), 
             snn = r_national_identification_numbers(n), 
             dob = r_date_of_births(n), 
             email = r_email_addresses(n), 
             ip = r_ipv4_addresses(n), 
             phone = r_phone_numbers(n), 
             credit_card = r_credit_card_numbers(n), 
             lat = r_latitudes(n), 
             lon = r_longitudes(n), 
             stringsAsFactors = FALSE)
knitr::kable(ashley_madison, format = "markdown")

Detect data containing PII

library(detector)
ashley_madison %>% 
  detect %>% 
  knitr::kable(format = "markdown")

Citation

To cite package ‘detector’ in publications use:

Paul Hendricks (2015). detector: Detect Data Containing Personally Identifiable Information. R package version 0.1.0. https://CRAN.R-project.org/package=detector

A BibTeX entry for LaTeX users is

@Manual{,
  title = {detector: Detect Data Containing Personally Identifiable Information},
  author = {Paul Hendricks},
  year = {2015},
  note = {R package version 0.1.0},
  url = {https://CRAN.R-project.org/package=detector},
}

paulhendricks/detector documentation built on May 24, 2019, 8:29 p.m.