# Raku Data::Generators [![Build Status](https://app.travis-ci.com/antononcube/Raku-Data-Generators.svg?branch=main)](https://app.travis-ci.com/github/antononcube/Raku-Data-Generators) [![License: Artistic-2.0](https://img.shields.io/badge/License-Artistic%202.0-0298c3.svg)](https://opensource.org/licenses/Artistic-2.0) This Raku package has functions for generating random strings, words, pet names, vectors, and (tabular) datasets. ### Motivation The primary motivation fo this package is to have simple, intuitively named functions for generating random vectors (lists) and datasets of different objects. Although, Raku has fairly good support of random vector generation, it is assumed that commands like this one are easier to use: ```{raku, eval = FALSE} say random-string(6, chars => 4, ranges => [ , "0".."9" ] ).raku; ``` ------ ## Random string The function `random-string` generates random strings. Here we generate a vector of random strings with length 4 and characters that belong to specified ranges: ```raku use Data::Generators; say random-string(6, chars => 4, ranges => [ , "0".."9" ] ).raku; ``` ``` # ("y65N", "44n8", "1835", "5967", "8nnY", "y69Y") ``` ------ ## Random word The function `random-word` generates random words. Here we generate a list with 12 random words: ```raku random-word(12) ``` ``` # (Ajax preconceived cybersex grad retreated Bastille barbu alms Jansenism cachou jack-o'-lantern vasovesiculitis) ``` Here we generate a table of random words of different types: ```raku use Data::Reshapers; my @dfWords = do for -> $wt { $wt => random-word(6, type => $wt) }; say to-pretty-table(@dfWords); ``` ``` # +--------+--------------+---------------+------------+--------------+-------------+--------+ # | | 1 | 4 | 3 | 5 | 2 | 0 | # +--------+--------------+---------------+------------+--------------+-------------+--------+ # | Any | phagocytosis | interoperable | fermium | topsoil | deceased | chirr | # | Common | jag | bullfighter | solidarity | wriggle | arouse | paddle | # | Known | comestible | insolate | sapropel | Ambrosiaceae | disinclined | Pomo | # | Stop | when's | well | we've | this | always | thus | # +--------+--------------+---------------+------------+--------------+-------------+--------+ ``` **Remark:** `Whatever` can be used instead of `'Any'`. **Remark:** The function `to-pretty-table` is from the package [Data::Reshapers](https://modules.raku.org/dist/Data::Reshapers:cpan:ANTONOV). ------ ## Random pet names The function `random-pet-name` generates random pet names. The pet names are taken from publicly available data of pet license registrations in the years 2015–2020 in Seattle, WA, USA. See [DG1]. The following command generates a list of six random pet names: ```raku srand(32); random-pet-name(6).raku ``` ``` # ("Phossy", "Fiona", "Guinness", "Hobie", "Guinness", "Hobie") ``` The named argument `species` can be used to specify specie of the random pet names. (According to the specie-name relationships in [DG1].) Here we generate a table of random pet names of different species: ```raku my @dfPetNames = do for -> $wt { $wt => random-pet-name(6, species => $wt) }; say to-pretty-table(@dfPetNames); ``` ``` # +------+-------------+--------+--------------+---------------+----------+--------------+ # | | 1 | 0 | 3 | 5 | 4 | 2 | # +------+-------------+--------+--------------+---------------+----------+--------------+ # | Any | Sullivan | Beep | Nick | Sassy | Asa | Bubby | # | Cat | J P Patches | Clouds | Bloemfontein | Baby Girl Kit | Deb0 | Mother Jones | # | Dog | Starfox | Rockyt | Evander | Olly | Pops | Bodri | # | Goat | Margot | Linda | Schmidt | Moppet | Winnipeg | Grayson | # | Pig | Guinness | Millie | Guinness | Atticus | Millie | Millie | # +------+-------------+--------+--------------+---------------+----------+--------------+ ``` **Remark:** `Whatever` can be used instead of `'Any'`. The named argument (adverb) `weighted` can be used to specify random pet name choice based on known real-life number of occurrences: ```raku srand(32); say ‌‌random-pet-name(6, :weighted).raku ``` ``` # ("Minx E Pinklefish", "Quinten", "Gavin", "Damocles", "Lula", "Lula") ``` The weights used correspond to the counts from [DG1]. **Remark:** The implementation of `random-pet-name` is based on the Mathematica implementation [`RandomPetName`](https://resources.wolframcloud.com/FunctionRepository/resources/RandomPetName), [AAf1]. ------ ## Random pretentious job titles The function `random-pretentious-job-title` generates random pretentious job titles. The following command generates a list of six random pretentious job titles: ```raku random-pretentious-job-title(6).raku ``` ``` # ("International Paradigm Manager", "National Security Planner", "Forward Response Associate", "Global Marketing Executive", "Interactive Tactics Strategist", "Dynamic Marketing Representative") ``` The named argument `number-of-words` can be used to control the number of words in the generated job titles. The named argument `language` can be used to control in which language the generated job titles are in. At this point, only Bulgarian and English are supported. Here we generate pretentious job titles using different languages and number of words per title: ```raku my $res = random-pretentious-job-title(12, number-of-words => Whatever, language => Whatever); say ‌‌to-pretty-table($res.rotor(3)); ``` ``` # +--------------------------+---------------------------------+---------------------------------+ # | 0 | 1 | 2 | # +--------------------------+---------------------------------+---------------------------------+ # | Плановик по Отчетност | Product Data Technician | Координатор | # | Representative | Посредник по Тактики | Architect | # | Супервайзор по Парадигми | Динамичен Техник по Креативност | Асистент | # | Консултант по Брандиране | Forward Security Strategist | National Communications Planner | # +--------------------------+---------------------------------+---------------------------------+ ``` **Remark:** `Whatever` can be used as values for the named arguments `number-of-words` and `language`. **Remark:** The implementation uses the job title phrases in https://www.bullshitjob.com . It is, more-or-less, based on the Mathematica implementation [`RandomPretentiousJobTitle`](https://resources.wolframcloud.com/FunctionRepository/resources/RandomPretentiousJobTitle), [AAf2]. ------ ## Random reals This module provides the function `random-variate` that can be used to generate lists of real numbers using distribution specifications. Here are examples: ```perl6 say random-variate(NormalDistribution.new(:mean(10), :sd(20)), 5); ``` ``` # (0.9333223924249852 -0.2593453912975026 -1.2293404131959242 -0.8629735815862949 0.253054780914651) ``` ```perl6 say random-variate(NormalDistribution.new( µ => 10, σ => 20), 5); ``` ``` # (0.912962008366543 -1.4262369021629255 -1.9644365475088528 1.508698427016814 0.6925171872211898) ``` ```perl6 say random-variate(UniformDistribution.new(:min(2), :max(60)), 5); ``` ``` # (31.014656143678515 13.701938196039467 28.513605047388047 45.21666865589838 58.35777047270862) ``` **Remark:** Only Normal distribution and Uniform distribution are implemented at this point. **Remark:** The signature design follows Mathematica's function [`RandomVariate`](https://reference.wolfram.com/language/ref/RandomVariate.html). Here is an example of 2D array generation: ```perl6 say random-variate(NormalDistribution.new, [3,4]); ``` ``` # [[0.6798357358973023 -0.7164338759583558 -1.707017522338361 -0.011712077286877743] # [-0.22406650929385863 -0.9791420337555385 -1.9618519572126158 1.1602797891392422] # [2.1835371401598787 -0.2197735309990484 -0.9849483011770795 -0.36601570847393833]] ``` ------ ## Random tabular dataset The function `random-tabular-dataset` can be used generate tabular *datasets*. **Remark:** In this module a *dataset* is (usually) an array of arrays of pairs. Here are basic calls: ```{perl6, eval=FALSE} random-tabular-dataset(); random-tabular-dataset(Whatever):row-names; random-tabular-dataset(Whatever, Whatever); random-tabular-dataset(12, 4); random-tabular-dataset(Whatever, 4); random-tabular-dataset(Whatever, ):!row-names; ``` Here is example of a generated tabular dataset that column names that are cat pet names: ```perl6 my @dfRand = random-tabular-dataset(5, 3, column-names-generator => { random-pet-name($_, species => 'Cat') }); say to-pretty-table(@dfRand); ``` ``` # +---------------+---------------------+-----------------+ # | Fenway | Cheddar Jo | Becks | # +---------------+---------------------+-----------------+ # | Issachar | 1.7500175355924807 | ungarbed | # | lupus | 1.2138238106460244 | Gymnosporangium | # | launce | 0.14299699937767568 | unreasoningly | # | promethium | -1.8751486787541933 | propene | # | steatocystoma | 1.5677561083608873 | fortemente | # +---------------+---------------------+-----------------+ ``` The display function `to-pretty-table` is from [`Data::Reshapers`](https://modules.raku.org/dist/Data::Reshapers:cpan:ANTONOV). **Remark:** At this point only [*wide format*](https://en.wikipedia.org/wiki/Wide_and_narrow_data) datasets are generated. (The long format implementation is high in my TOOD list.) **Remark:** The signature design and implementation are based on the Mathematica implementation [`RandomTabularDataset`](https://resources.wolframcloud.com/FunctionRepository/resources/RandomTabularDataset), [AAf3]. ------ ## TODO 1. [ ] Random tabular datasets generation - [X] Row spec - [X] Column spec that takes columns count and column names - [X] Column names generator - [X] Wide form implementation only - [ ] Long form implementation - [ ] Generators of column values - [ ] Max number of values - [ ] Min number of values - [ ] Form (long or wide) - [X] Row names (automatic) 2. [X] Random reals vectors generation 3. [ ] Figuring out how to handle and indicate missing values 4. [ ] Random reals vectors generation according to distribution specs - [X] Uniform distribution - [X] Normal distribution - [ ] Poisson distribution - [ ] Skew-normal distribution - [ ] Triangular distribution 5. [ ] Selection between `roll` and `pick` for: - [ ] `RandomWord` - [ ] `RandomPetName` ------ ## References ### Articles [AA1] Anton Antonov, ["Pets licensing data analysis"](https://mathematicaforprediction.wordpress.com/2020/01/20/pets-licensing-data-analysis/), (2020), [MathematicaForPrediction at WordPress](https://mathematicaforprediction.wordpress.com). ### Functions, packages [AAf1] Anton Antonov, [RandomPetName](https://resources.wolframcloud.com/FunctionRepository/resources/RandomPetName), (2021), [Wolfram Function Repository](https://resources.wolframcloud.com/FunctionRepository). [AAf2] Anton Antonov, [RandomPretentiousJobTitle](https://resources.wolframcloud.com/FunctionRepository/resources/RandomPretentiousJobTitle), (2021), [Wolfram Function Repository](https://resources.wolframcloud.com/FunctionRepository). [AAf3] Anton Antonov, [RandomTabularDataset](https://resources.wolframcloud.com/FunctionRepository/resources/RandomTabularDataset), (2021), [Wolfram Function Repository](https://resources.wolframcloud.com/FunctionRepository). [SHf1] Sander Huisman, [RandomString](https://resources.wolframcloud.com/FunctionRepository/resources/RandomString), (2021), [Wolfram Function Repository](https://resources.wolframcloud.com/FunctionRepository). [WRI1] Wolfram Research (2010), [RandomVariate](https://reference.wolfram.com/language/ref/RandomVariate.html), Wolfram Language function. ### Data repositories [DG1] Data.Gov, [Seattle Pet Licenses](https://catalog.data.gov/dataset/seattle-pet-licenses), [catalog.data.gov](https://catalog.data.gov).