Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://thinkr-open.github.io/fakir/
Create Fake Data in R for tutorials
https://thinkr-open.github.io/fakir/
charlatan fake-datasets golemverse hacktoberfest r r-package rstats
Last synced: about 1 month ago
JSON representation
Create Fake Data in R for tutorials
- Host: GitHub
- URL: https://thinkr-open.github.io/fakir/
- Owner: ThinkR-open
- License: other
- Created: 2018-04-18T08:02:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T06:26:59.000Z (about 1 year ago)
- Last Synced: 2023-11-20T16:01:16.089Z (7 months ago)
- Topics: charlatan, fake-datasets, golemverse, hacktoberfest, r, r-package, rstats
- Language: R
- Homepage: https://thinkr-open.github.io/fakir/
- Size: 9.46 MB
- Stars: 126
- Watchers: 11
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-r-learning-resources - Fakir - Create Fake Data in R for Tutorials - Author: Colin Fay. (Topic Areas / Uncategorized)
README
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
comment = "",
fig.path = "man/figures/README-",
out.width = "50%",
fig.align = "center",
message = FALSE,
eval = TRUE
)
```
# fakir 
[](https://app.codecov.io/gh/ThinkR-open/fakir?branch=master)
[](https://github.com/ThinkR-open/fakir/actions/workflows/R-CMD-check.yaml)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
The goal of `{fakir}` is to provide fake datasets that can be used for prototyping or teaching purpose.
The full documentation is in this `{pkgdown} `site: .
`{fakir}` is part of the [golemverse](https://golemverse.org/).
## About
You're reading the doc about version : `r pkgload::pkg_version()`
This README has been compiled on the
```{r}
Sys.time()
```
Here are the test & coverage results :
```{r}
devtools::check(quiet = TRUE)
```
```{r echo = FALSE}
unloadNamespace("fakir")
```
```{r eval = TRUE, message = TRUE}
covr::package_coverage()
```
## Installation
You can install the released version of `{fakir}` from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("fakir")
```
Or the development version from GitHub with:
```r
# From r-universe.dev (No need for GITHUB_PAT)
install.packages(
"fakir",
repos = c("thinkropen" = "https://thinkr-open.r-universe.dev")
)
# With {remotes} using GitHub API
# install.packages("remotes")
remotes::install_github("ThinkR-open/fakir")
```
## Characteristics & usage
This package is designed for simulating real life datasets:
- some datasets follow the tidy-data principles, others don't.
- Some missing values are set for numeric and categorical variables
- Some variables values are correlated
Supported languages are, for now, French and US English.
See the Vignette for examples.
## Prior work
This package is heavily inspired by [{charlatan}](https://github.com/ropensci/charlatan).
Scott Chamberlain (2017). charlatan: Make Fake Data. R package version 0.1.0.
https://CRAN.R-project.org/package=charlatan
## Contribute
You can contribute to ``{fakir}`` in two ways:
### Translate
You can translate to other locales by providing :
+ new `vec` in "R/utils"
+ new `local` in "R/fake_client" and "R/fake_transport"
### New dataset
Feel free to create new datasets generators.
## Code of Conduct
Please note that the fakir project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). By contributing to this project, you agree to abide by its terms.