proceduralnames

Would a rose by any procedurally generated name still smell as sweet?

Lifecycle: maturing License: Apache 2.0 CRAN status codecov Project Status: Active – The project has reached a stable, usable state and is being actively developed. R build status

The goal of proceduralnames is to make it easy to quickly generate unique-enough identifier strings for easy differentiation of objects or observations.

Installation

If the CRAN badge above is green, you can install the released version of proceduralnames from CRAN with:

install.packages("proceduralnames")

You can always install the development version of proceduralnames from GitHub via:

remotes::install.github("mikemahoney218/proceduralnames")

Usage

At the moment, proceduralnames provides three user-facing functions: make_docker_names, make_english_names, and make_spanish_names. make_docker_names makes names in the same way Docker generates names for its containers:

library(proceduralnames)
make_docker_names(1)
#> [1] "optimistic_shirley"

make_english_names and make_spanish_names both generate names using a subset of the 1,000 most common words in English or Spanish, respectively:

make_english_names(1)
#> [1] "night_solve_noise"
make_spanish_names(1)
#> [1] "grandes_silencio_programa"

All three functions can be used to generate multiple names by providing a different number to the n argument. make_english_names and make_spanish_names both have an argument, n_words, which can be used to alter the number of words combined for each name. All three functions also have an argument, retry (named after the argument used in generating Docker container names) which will append a random integer between 1 and 10 to the end of each name:

make_docker_names(1, retry = TRUE)
#> [1] "confident_mclean9"

In addition to these functions, proceduralnames provides the data sets each function draws from (namely, docker_adjectives, docker_names, common_words, and spanish_words). These data may evolve with each release of the package, so try not to depend on the length and contents of each vector remaining constant, but the fundamental shape of each object will remain stable.

Note that the emphasis of this package is on generating human-readable identifiers, not necessarily universally unique strings. If you need strings which are functionally universally unique for your application, look into the uuid package.