charlatan

Create fake data in R

https://github.com/ropensci/charlatan

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 18 committers (5.6%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.4%) to scientific vocabulary

Keywords

data dataset fake-data faker peer-reviewed r r-package rstats

Keywords from Contributors

genome biodiversity biology darwincore nomenclature taxize taxonomy solar-radiation temperature wind

Last synced: 6 months ago · JSON representation

Repository

Create fake data in R

Basic Info

Host: GitHub
Owner: ropensci
License: other
Language: R
Default Branch: master
Homepage: https://docs.ropensci.org/charlatan/
Size: 1010 KB

Statistics

Stars: 303
Watchers: 8
Forks: 27
Open Issues: 29
Releases: 7

Topics

data dataset fake-data faker peer-reviewed r r-package rstats

Created about 9 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog Contributing License Codemeta

README.Rmd

charlatan
=========

```{r echo=FALSE}
knitr::opts_chunk$set(
  comment = "#>",
  collapse = TRUE,
  warning = FALSE,
  message = FALSE
)
```

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-check](https://github.com/ropensci/charlatan/workflows/R-check/badge.svg)](https://github.com/ropensci/charlatan/actions?query=workflow%3AR-check)
[![cran checks](https://badges.cranchecks.info/worst/charlatan.svg)](https://cloud.r-project.org/web/checks/check_results_charlatan.html)
[![cran status](https://www.r-pkg.org/badges/version/charlatan)](https://cran.r-project.org/package=charlatan)
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/charlatan)](https://github.com/r-hub/cranlogs.app)
[![](https://badges.ropensci.org/94_status.svg)](https://github.com/ropensci/software-review/issues/94)
[![R-CMD-check](https://github.com/ropensci/charlatan/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/charlatan/actions/workflows/R-CMD-check.yaml)



`charlatan` makes fake data, inspired from and borrowing some code from Python's faker (https://github.com/joke2k/faker)

Make fake data for:

* person names
* jobs
* phone numbers
* colors: names, hex, rgb
* credit cards
* DOIs
* numbers in range and from distributions
* gene sequences
* geographic coordinates
* emails
* URIs, URLs, and their parts
* IP addresses
* more coming ...

Possible use cases for `charlatan`:

* Students in a classroom setting learning any task that needs a dataset.
* People doing simulations/modeling that need some fake data
* Generate fake dataset of users for a database before actual users exist
* Complete missing spots in a dataset
* Generate fake data to replace sensitive real data with before public release
* Create a random set of colors for visualization
* Generate random coordinates for a map
* Get a set of randomly generated DOIs (Digital Object Identifiers) to
assign to fake scholarly artifacts
* Generate fake taxonomic names for a biological dataset
* Get a set of fake sequences to use to test code/software that uses
sequence data

Reasons to use `charlatan`:

* Light weight, few dependencies
* Relatively comprehensive types of data, and more being added
* Comprehensive set of languages supported, more being added
* Useful R features such as creating entire fake data.frame's

## Installation

cran version

```{r eval=FALSE}
install.packages("charlatan")
```

dev version

```{r eval=FALSE}
remotes::install_github("ropensci/charlatan")
```

```{r}
library("charlatan")
set.seed(12345)
```

## high level function

... for all fake data operations

```{r}
x <- fraudster()
x$job()
x$name()
x$color_name()
```

## locale support

```{r}
ch_job(locale = "fr_FR", n = 3)
ch_job(locale = "hr_HR", n = 3)
ch_job(locale = "uk_UA", n = 3)
ch_job(locale = "zh_TW", n = 3)
```

## generate a dataset

```{r}
ch_generate()
```

```{r}
ch_generate("job", "phone_number", n = 30)
```

## job

```{r}
ch_job()
```

```{r}
ch_job(10)
```

## credit cards

```{r}
ch_credit_card_provider()
ch_credit_card_provider(n = 4)
```

```{r}
ch_credit_card_number(n = 10)
```

```{r}
ch_credit_card_security_code()
ch_credit_card_security_code(10)
```

## Documentation

All providers have documentation available through the help functions.
All providers of the same locales, are linked together, and for every language
we have a generic page, for example```?`dutch-language` ```.

There are three vignettes, about contributing to this project, what {charlatan}
does and a more in depth vignette about creating realistic data.

## Usage in the wild

- eacton/R-Utility-Belt-ggplot2 (https://github.com/eacton/R-Utility-Belt-ggplot2/blob/836a6bd303fbfde4a334d351e0d1c63f71c4ec68/furry_dataset.R)


## Contributors
* Roel M. Hogervorst (https://github.com/rmhogervorst)
* Scott Chamberlain (https://github.com/sckott)
* Kyle Voytovich (https://github.com/kylevoyto)
* Martin Pedersen (https://github.com/MartinMSPedersen)

If you would like to contribute, see [CONTRIBUTING (on github)](.github/CONTRIBUTING.md)

## similar art

* wakefield (https://github.com/trinker/wakefield)
* ids (https://github.com/richfitz/ids)
* rcorpora (https://github.com/gaborcsardi/rcorpora)
* synthpop (https://cran.r-project.org/package=synthpop)

## Meta

* Please [report any issues or bugs](https://github.com/ropensci/charlatan/issues).
* License: MIT
* Get citation information for `charlatan` in R doing `citation(package = 'charlatan')`
* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

Owner

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "charlatan",
  "description": "Make fake data that looks realistic, supporting addresses, person names, dates, times, colors, coordinates, currencies, digital object identifiers ('DOIs'), jobs, phone numbers, 'DNA' sequences, doubles and integers from distributions and within a range.",
  "name": "charlatan: Make Fake Data",
  "relatedLink": "https://docs.ropensci.org/charlatan/",
  "codeRepository": "https://github.com/ropensci/charlatan",
  "issueTracker": "https://github.com/ropensci/charlatan/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.6.1",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.1 (2024-06-14)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Roel M.",
      "familyName": "Hogervorst",
      "email": "hogervorst.rm@gmail.com",
      "@id": "https://orcid.org/0000-0001-7509-0328"
    },
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Chamberlain",
      "@id": "https://orcid.org/0000-0003-1444-9135"
    },
    {
      "@type": "Person",
      "givenName": "Kyle",
      "familyName": "Voytovich"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Martin",
      "familyName": "Pedersen"
    }
  ],
  "funder": [
    {
      "@type": "Organization",
      "name": "rOpenSci"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Roel M.",
      "familyName": "Hogervorst",
      "email": "hogervorst.rm@gmail.com",
      "@id": "https://orcid.org/0000-0001-7509-0328"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "ipaddress",
      "name": "ipaddress",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ipaddress"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "stringi",
      "name": "stringi",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=stringi"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "spelling",
      "name": "spelling",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=spelling"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R6",
      "name": "R6",
      "version": ">= 2.2.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=R6"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "tibble",
      "name": "tibble",
      "version": ">= 1.2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tibble"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "whisker",
      "name": "whisker",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=whisker"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 2.10"
    },
    "SystemRequirements": null
  },
  "fileSize": "2658.6KB",
  "releaseNotes": "https://github.com/ropensci/charlatan/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/charlatan/blob/master/README.md",
  "contIntegration": [
    "https://github.com/ropensci/charlatan/actions?query=workflow%3AR-check",
    "https://github.com/ropensci/charlatan/actions/workflows/R-CMD-check.yaml"
  ],
  "developmentStatus": "https://www.repostatus.org/#active",
  "review": {
    "@type": "Review",
    "url": "https://github.com/ropensci/software-review/issues/94",
    "provider": "https://ropensci.org"
  },
  "keywords": [
    "data",
    "faker",
    "rstats",
    "dataset",
    "fake-data",
    "r",
    "r-package",
    "peer-reviewed"
  ]
}

GitHub Events

Total

Create event: 1
Release event: 1
Issues event: 4
Watch event: 14
Delete event: 1
Issue comment event: 1
Push event: 7

Last Year

Create event: 1
Release event: 1
Issues event: 4
Watch event: 14
Delete event: 1
Issue comment event: 1
Push event: 7

Committers

Last synced: about 2 years ago

All Time

Total Commits: 262
Total Committers: 18
Avg Commits per committer: 14.556
Development Distribution Score (DDS): 0.237

Past Year

Commits: 12
Committers: 3
Avg Commits per committer: 4.0
Development Distribution Score (DDS): 0.25

Top Committers

Name	Email	Commits
Scott Chamberlain	m**s@g**m	200
Kyle Voytovich	k**o@g**m	16
Roel M. Hogervorst	h**m@g**m	12
Martin M. S. Pedersen	m**n@l**m	7
Jesus M. Castagnetto	j**s@c**m	3
Kasia	k**a@m**m	3
Roel Hogervorst	R****t	3
TJ Mahr	t****r	3
Neal Fultz	n**z@g**m	2
Jas Sohi	j**i@c**m	2
Mark Baas	m**s@g**m	2
David Hall	d**s@g**m	2
Patrick Hausmann	p**n@c**e	2
abichat	a**t@y**r	1
Jeroen Ooms	j**s@g**m	1
Tristan Jay Mahr	M**r@W**u	1
Martin M. S. Pedersen	t**r@g**m	1
Karthik Ram	k**m@g**m	1

Committer Domains (Top 20 + Academic)

wisc.edu: 1 covimo.de: 1 cardinalpath.com: 1 mango-solutions.com: 1 castagnetto.com: 1 linux.com: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time

Total issues: 85
Total pull requests: 32
Average time to close issues: 10 months
Average time to close pull requests: about 1 month
Total issue authors: 12
Total pull request authors: 14
Average comments per issue: 1.41
Average comments per pull request: 3.41
Merged pull requests: 28
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 3
Pull requests: 1
Average time to close issues: 1 day
Average time to close pull requests: 2 days
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 1.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

sckott (50)
RMHogervorst (15)
maelle (5)
kylevoyto (4)
patperu (3)
aalexandersson (1)
njtierney (1)
ammubharatram (1)
higgi13425 (1)
noamross (1)
zx8754 (1)
sariya (1)

Pull Request Authors

RMHogervorst (10)
kylevoyto (7)
MartinMSPedersen (4)
starship9 (2)
markbaas (2)
tjmahr (2)
KKulma (1)
karthik (1)
nfultz (1)
jmcastagnetto (1)
patperu (1)
abichat (1)
davidchall (1)
j450h1 (1)

Top Labels

Issue Labels

feature (11) internals (9) review (7) from-email (6) later (5) good-first-issue (2) help wanted (2) docs (2) hacktoberfest (2) type: provider (1)

Pull Request Labels

docs (2)

Packages

Total packages: 2
Total downloads:
- cran 603 last-month
Total docker downloads: 88,747

Total dependent packages: 4
(may contain duplicates)
Total dependent repositories: 5
(may contain duplicates)
Total versions: 16
Total maintainers: 1

proxy.golang.org: github.com/ropensci/charlatan

Documentation: https://pkg.go.dev/github.com/ropensci/charlatan#section-documentation
License: other
Latest release: v0.6.1
published over 1 year ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

cran.r-project.org: charlatan

Make Fake Data

Homepage: https://docs.ropensci.org/charlatan/
Documentation: http://cran.r-project.org/web/packages/charlatan/charlatan.pdf
License: MIT + file LICENSE
Latest release: 0.6.1
published over 1 year ago

Versions: 8
Dependent Packages: 4
Dependent Repositories: 5
Downloads: 603 Last month
Docker Downloads: 88,747

Rankings

Docker downloads count: 0.0%

Dependent packages count: 9.3%

Average: 9.8%

Dependent repos count: 13.1%

Downloads: 16.9%

Maintainers (1)

hogervorst.rm@gmail.com

Last synced: 6 months ago

Dependencies

DESCRIPTION cran

R6 >= 2.2.0 imports
tibble >= 1.2 imports
whisker * imports
ipaddress * suggests
knitr * suggests
rmarkdown * suggests
stringi * suggests
testthat * suggests

.github/workflows/R-check.yml actions

actions/checkout v2 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite