teebusch / noah Goto Github PK

If the user wants the ark to be reproducible without storing it somewhere, it should be enough to use a random seed.
It's possible for the user to do this themselves, but adding it as a function argument .random_seed = NULL might still be more convenient.

Some of the adjectives or animals could be perceived as offensive or irritating when used in a more serious context. It would be nice to have a way to customize the word lists.

• Perhaps a "family-friendly" word list should be provided?
• Perhaps, the data should be made external (user-accessible), so that it can be modified (filtered) easily by the user?

currently the only way to make alliterations is to create an ark with Ark$new(alliterate = TRUE). Then all pseudonyms from that Ark will be alliterations. It would be better to be able to temporarily request only alliterations from an existing Ark.

Currently, the pseudonym name parts are shuffled using index_shuffled, which is integer vector, containing a permutation of the index (from 1 to max_length). This permutation is stored with the Ark object.
This is feasible as long as max_length isn't too large (i.e., the number of name parts is small). However, as max_length increases, the memory use will increase. Many of the stored indices may never be used.
A more efficient way to store the permutation could be a generator-like function, that yields a new (unique) random value from the range 1:max_length whenever one is requested.

A pckdown page bundles the documentation in a easily accessible format and is generated automatically from the package. It would be good to have one.

• The print function should show the settings of the Ark (currently, whether it alliterates by default)
• The print function should make clear how many alliterations are left in the ark, and how many psudonyms are in it in total.

Add words from https://github.com/nas5w/random-word-slugs

Currently only 2-part names are possible because of how index is converted to parts in index_to_pseudonym()
For more flexibility and more possible pseudonyms, more name parts should be allowed.

related to #23

clean_name_parts isn't always creating desired output, for example

• "McCartney" becomes "Mccartney"
• "III" becomes "Iii"

R creates floats by default when using single numbers, but integers when using the range notation 1:3.
This creates unexpected behaviour:

library(noah)
ark <- Ark$new(parts = list(
  foo = c("one", "two", "three"),
  bar = c("fi", "fa", "fu")
))
max_total <- 9
ark$pseudonymize(1:5)
#> [1] "Two Fi"   "Three Fi" "Two Fu"   "Three Fa" "One Fi"
ark$pseudonymize(5L)  # gets theexisting pseudonym for 5
#> [1] "One Fi"
ark$pseudonymize(5)   # gets new pseudonym
#> [1] "Three Fu"
print(ark)
#> # An Ark: 6 / 9 pseudonyms used (1%)
#>   key         pseudonym
#>   <md5>       <Attribute Animal>
#> 1 14fa27a6... Three Fu
#> 2 216deaa6... Two Fi
#> 3 3297603a... One Fi
#> 4 8357d673... Three Fi
#> 5 9380ec58... Three Fa
#> 6 ee415bd5... Two Fu

Instead of the default (adjective animal) there should be an option to supply your own name parts when the ark is created. This would also allow tests that run more quickly.

Currently the shuffled index is stored as a a:n numerical vector, wasting a lot of space. One could use a combination of FIsher-Yates random sampling and run length encoding to save memory

Currently the Ark throws an error when more unique pseudonyms than possible are requested. The Error message is relatively generic. It should instead provide some guidance on why the problem occured and how to solve it.

It seems like every real package needs a hex sticker nowadays. How about a boat with some happy animals on it? SOmething friendly and silly. Abyss free font maybe?

Alliterations are more fun and may be easier to remember. The pseudonymize() function should have an option to return only pseudonyms with alliterations.

Give pseudonyms in console output different colors (should be consistent. May be able to do this with pillar and vctrs?

The error message is not very informative. Should be something like "arguments should have the same length". Recycling should not be permitted.

library(noah)

pseudonymize(1:3, 1:2)
#> Error: Can't recycle `..1` (size 3) to match `..2` (size 2).

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