thinkr-open / fakir

Create Fake Data in R for tutorials

fakir

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: https://thinkr-open.github.io/fakir/.

{fakir} is part of the golemverse.

About

You’re reading the doc about version : 1.0.0

This README has been compiled on the

Sys.time()

[1] "2023-04-06 09:24:34 CEST"

Here are the test & coverage results :

devtools::check(quiet = TRUE)

── R CMD check results ──────────────────────────────────────── fakir 1.0.0 ────
Duration: 28.2s

0 errors ✔ | 0 warnings ✔ | 0 notes ✔

covr::package_coverage()

fakir Coverage: 94.78%

R/utils.R: 86.96%

R/fake_transport.R: 89.89%

R/fake_client.R: 93.48%

R/fake_products.R: 100.00%

R/fake_web.R: 100.00%

Installation

You can install the released version of {fakir} from CRAN with:

install.packages("fakir")

Or the development version from GitHub with:

# 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}.

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. By contributing to this project, you agree to abide by its terms.

fakir's Issues

Release fakir 1.0.0

First release:

• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• Check if any deprecation processes should be advanced, as described in Gradual deprecation
• devtools::build_readme()
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• rhub::check_for_cran()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('major')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• git push
• usethis::use_github_release()
• usethis::use_dev_version()
• git push
• Finish blog post
• Tweet
• Add link to blog post in pkgdown news menu

upcoming changes in charlatan

Hi Team!

I'm the new maintainer of the charlatan package that you use in some of your functions.
I'm giving you a heads-up because I'm going to change a lot in version 0.6.0 of the package.
There might even be more components you want to incorporate in your package!

Details about your use of charlatan, and what to do about it.

Your package uses

importFrom(charlatan,ch_color_name)
importFrom(charlatan,ch_company)
importFrom(charlatan,ch_credit_card_provider)
importFrom(charlatan,ch_job)
charlatan::ch_element_symbol(1)
@importFrom charlatan ch_name ch_credit_card_provider ch_job
@importFrom charlatan ch_name ch_credit_card_provider ch_job

The functionality of the all these functions remain the same, but it is wise to set the locale to en_US
to make it clear what locale you want to use.
The default locale for all providers in charlatan will always be 'en_US' but future versions will start to warn if locale is not explicitly set.

See ropensci/charlatan#140

Thanks for using the package!

Roel

Blogpost: Fakir

Hello,

I had just put together a small blogpost on this, thought to share with you https://www.programmingwithr.com/how-to-generate-meaningful-fake-data-for-learning-experimentation-and-teaching/

Thanks,
Abdul

Use base::gettext for translation

Instead of manually implementing english and french in utils.R, we could instead use the built-in gettext functions.

See also https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Internationalization and ?gettext

The repo URL should be https://thinkr-open.github.io/fakir/

:-)

Error in fake_base_clients()

library(fakir)
fake_base_clients(n = 12)
#> Error: All columns in a tibble must be vectors.
#> x Column `geometry` is a `sfc_MULTIPOLYGON/sfc` object.

^{Created on 2020-04-16 by the reprex package (v0.3.0)}

Session info

devtools::session_info()
#> ─ Session info ───────────────────────────────────────────────────────────────
#>  setting  value                       
#>  version  R version 3.6.1 (2019-07-05)
#>  os       macOS Mojave 10.14.3        
#>  system   x86_64, darwin15.6.0        
#>  ui       X11                         
#>  language (EN)                        
#>  collate  en_US.UTF-8                 
#>  ctype    en_US.UTF-8                 
#>  tz       Europe/Paris                
#>  date     2020-04-16                  
#> 
#> ─ Packages ───────────────────────────────────────────────────────────────────
#>  package     * version    date       lib source                            
#>  assertthat    0.2.1      2019-03-21 [1] CRAN (R 3.6.0)                    
#>  attempt       0.3.0      2019-04-08 [1] CRAN (R 3.6.1)                    
#>  backports     1.1.5      2019-10-02 [1] CRAN (R 3.6.0)                    
#>  callr         3.4.3      2020-03-28 [1] CRAN (R 3.6.2)                    
#>  charlatan     0.4.0      2020-01-24 [1] CRAN (R 3.6.0)                    
#>  cli           2.0.2      2020-02-28 [1] CRAN (R 3.6.0)                    
#>  crayon        1.3.4      2017-09-16 [1] CRAN (R 3.6.0)                    
#>  desc          1.2.0      2018-05-01 [1] CRAN (R 3.6.0)                    
#>  devtools      2.2.2      2020-02-17 [1] CRAN (R 3.6.0)                    
#>  digest        0.6.25     2020-02-23 [1] CRAN (R 3.6.0)                    
#>  dplyr         0.8.5      2020-03-07 [1] CRAN (R 3.6.0)                    
#>  ellipsis      0.3.0      2019-09-20 [1] CRAN (R 3.6.0)                    
#>  evaluate      0.14       2019-05-28 [1] CRAN (R 3.6.0)                    
#>  fakir       * 0.2.0      2020-04-16 [1] Github (Thinkr-open/fakir@2fc3621)
#>  fansi         0.4.1      2020-01-08 [1] CRAN (R 3.6.0)                    
#>  fs            1.4.0      2020-03-31 [1] CRAN (R 3.6.1)                    
#>  glue          1.3.2      2020-03-12 [1] CRAN (R 3.6.0)                    
#>  highr         0.8        2019-03-20 [1] CRAN (R 3.6.0)                    
#>  htmltools     0.4.0      2019-10-04 [1] CRAN (R 3.6.0)                    
#>  knitr         1.28       2020-02-06 [1] CRAN (R 3.6.0)                    
#>  lifecycle     0.2.0.9000 2020-03-22 [1] Github (r-lib/lifecycle@355dcba)  
#>  lubridate     1.7.4      2018-04-11 [1] CRAN (R 3.6.0)                    
#>  magrittr      1.5        2014-11-22 [1] CRAN (R 3.6.0)                    
#>  memoise       1.1.0      2017-04-21 [1] CRAN (R 3.6.0)                    
#>  pillar        1.4.3      2019-12-20 [1] CRAN (R 3.6.0)                    
#>  pkgbuild      1.0.6      2019-10-09 [1] CRAN (R 3.6.0)                    
#>  pkgconfig     2.0.3      2019-09-22 [1] CRAN (R 3.6.0)                    
#>  pkgload       1.0.2      2018-10-29 [1] CRAN (R 3.6.0)                    
#>  prettyunits   1.1.1      2020-01-24 [1] CRAN (R 3.6.0)                    
#>  processx      3.4.2      2020-02-09 [1] CRAN (R 3.6.0)                    
#>  ps            1.3.2      2020-02-13 [1] CRAN (R 3.6.0)                    
#>  purrr         0.3.3      2019-10-18 [1] CRAN (R 3.6.0)                    
#>  R6            2.4.1      2019-11-12 [1] CRAN (R 3.6.0)                    
#>  Rcpp          1.0.4      2020-03-17 [1] CRAN (R 3.6.0)                    
#>  remotes       2.1.1      2020-02-15 [1] CRAN (R 3.6.0)                    
#>  rlang         0.4.5      2020-03-01 [1] CRAN (R 3.6.0)                    
#>  rmarkdown     2.1        2020-01-20 [1] CRAN (R 3.6.0)                    
#>  rprojroot     1.3-2      2018-01-03 [1] CRAN (R 3.6.0)                    
#>  sessioninfo   1.1.1      2018-11-05 [1] CRAN (R 3.6.0)                    
#>  stringi       1.4.6      2020-02-17 [1] CRAN (R 3.6.0)                    
#>  stringr       1.4.0      2019-02-10 [1] CRAN (R 3.6.0)                    
#>  testthat      2.3.2      2020-03-02 [1] CRAN (R 3.6.0)                    
#>  tibble        3.0.0      2020-03-30 [1] CRAN (R 3.6.2)                    
#>  tidyr         1.0.2      2020-01-24 [1] CRAN (R 3.6.0)                    
#>  tidyselect    1.0.0      2020-01-27 [1] CRAN (R 3.6.0)                    
#>  usethis       1.5.1      2019-07-04 [1] CRAN (R 3.6.0)                    
#>  vctrs         0.2.4      2020-03-10 [1] CRAN (R 3.6.0)                    
#>  whisker       0.4        2019-08-28 [1] CRAN (R 3.6.0)                    
#>  withr         2.1.2      2018-03-15 [1] CRAN (R 3.6.0)                    
#>  xfun          0.12       2020-01-13 [1] CRAN (R 3.6.0)                    
#>  yaml          2.2.1      2020-02-01 [1] CRAN (R 3.6.0)                    
#> 
#> [1] /Library/Frameworks/R.framework/Versions/3.6/Resources/library

New dataset ideas

Idea for new fake datasets:

• Movies
• Sport (maybe basket)
• Product review (a la amazon)
• Tweets
• Pharma related