Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paulhendricks/generator

Generate data containing fake Personally Identifiable Information (PII) in R
https://github.com/paulhendricks/generator

Last synced: 6 days ago
JSON representation

Generate data containing fake Personally Identifiable Information (PII) in R

Host: GitHub
URL: https://github.com/paulhendricks/generator
Owner: paulhendricks
License: other
Created: 2015-08-21T19:37:19.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2017-07-01T20:07:16.000Z (over 7 years ago)
Last Synced: 2024-08-13T07:14:16.989Z (3 months ago)
Language: R
Homepage:
Size: 66.4 KB
Stars: 22
Watchers: 4
Forks: 5
Open Issues: 3
Metadata Files:
- Readme: README.Rmd
- License: LICENSE

Awesome Lists containing this project

jimsghstars - paulhendricks/generator - Generate data containing fake Personally Identifiable Information (PII) in R (R)

README

        ---

output:

  github_document

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "README-"

)

```

# generator

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/generator)](http://cran.r-project.org/package=generator)

[![Downloads from the RStudio CRAN mirror](http://cranlogs.r-pkg.org/badges/generator)](http://cran.rstudio.com/package=generator)

[![Build Status](https://travis-ci.org/paulhendricks/generator.png?branch=master)](https://travis-ci.org/paulhendricks/generator)

[![Build status](https://ci.appveyor.com/api/projects/status/c5vv1efvrsynt4js/branch/master?svg=true)](https://ci.appveyor.com/project/paulhendricks/generator/branch/master)

[![codecov.io](http://codecov.io/github/paulhendricks/generator/coverage.svg?branch=master)](http://codecov.io/github/paulhendricks/generator?branch=master)

[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/0.1.0/active.svg)](http://www.repostatus.org/#active)

`generator` generates data containing fake [Personally Identifiable Information](https://en.wikipedia.org/wiki/Personally_identifiable_information) (PII). Once complete, `generator` will be able to generate the following types of PII:

* Full name 

* Home address 

* E-mail address 

* National identification number 

* Passport 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!

* Full name

* E-mail address 

* Date of birth

* Telephone number 

* Latitude and longtiude 

### Needs more work...

* National identification number

* IP address 

* Credit card number

### Haven't even started :(

* Home address

* Vehicle registration plate number

* Driver's license number

* Birthplace 

## Installation

You can install the latest development version from CRAN:

```R

install.packages("generator")

````

Or from GitHub with:

```R

if (packageVersion("devtools") < 1.6) {

  install.packages("devtools")

}

devtools::install_github("paulhendricks/generator")

```

If you encounter a clear bug, please file a [minimal reproducible example](http://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example) on [GitHub](https://github.com/paulhendricks/generator/issues).

## API

### Generate data containing fake PII

```{r}

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

```

## Citation

To cite package ‘generator’ in publications use:

```

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

```

A BibTeX entry for LaTeX users is

```

@Manual{,

  title = {generator: Generate Data Containing Fake Personally Identifiable

Information},

  author = {Paul Hendricks},

  year = {2015},

  note = {R package version 0.1.0},

  url = {https://CRAN.R-project.org/package=generator},

}

```