README.md

Generation of Code Names for Organizations, People, Projects, and Whatever Else

{codename} allows for users to create short, pithy code names for their organizations, their work projects, themselves, other people, or whatever else. The core of this package is the eponymous codename() function, which allows the user to create various types of code names. The code names returned from this function, by in large, are a two-word character vector of an attribute and an object. Right now, options include “any” (which is default and incorporates a battery of adjectives and nouns), “gods” (in which the object is the name of a deity or saint from some religion), “ubuntu” (in which the code name is alliterative but the object is always an animal), and “wu-tang” (in which the code name is derived from the classic Wu-Tang Name Generator). codename() also features the ability to use reproducible seeds, including character seeds, for maximum transparency and reproducibility.

Installation

You will ideally soon be able to install this on CRAN, as follows:

install.packages("codename")

Until then, you can install the development version of this package through the devtools package.

devtools::install_github("svmiller/codename")

Usage

There isn’t much to belabor here and usage should be self-explanatory. Here is some sample output.

library(codename)

# Generate console message about package version.
# Successive updates may break the expected output of a reproducible seed.
# This just adds some layer of transparency/clarity.
codename_message()
#> code name generated by {codename} v.0.4.0

# defaults to any
codename()
#> [1] "creamy escalator"
codename()
#> [1] "greenish grey necktie"
codename()
#> [1] "realistic democrat"
codename()
#> [1] "yellow brown mammal"
codename(seed = 8675309)
#> [1] "yellow orange twist"
codename(seed = "My Project Name: The Subtitle of It Too")
#> [1] "bright blue barbiturate"

codename(type = "gods")
#> [1] "any inti"
codename(type = "gods")
#> [1] "heavy jurate"
codename(type = "gods")
#> [1] "bright aqua austeja"
codename(type = "gods", seed = 8675309)
#> [1] "scholarly wakan tanka"

codename(type = "ubuntu")
#> [1] "second-hand sole"
codename(type = "ubuntu")
#> [1] "fatal flyingfish"
codename(type = "ubuntu")
#> [1] "puzzling pony"
codename(type = "ubuntu", seed = 8675309)
#> [1] "moss mandrill"
codename(type = "ubuntu", seed = "My Ubuntu Release")
#> [1] "toupe tahr"

codename(type = "wu-tang")
#> [1] "Phantom Lover"
codename(type = "wu-tang")
#> [1] "Smilin’ Commander"
codename(type = "wu-tang")
#> [1] "Midnight Demon"
codename(type = "wu-tang", seed = "Steven V. Miller")
#> [1] "X-cessive Observer"

variety_pack(seed = "A Reproducible Character Seed")
#> [1] "afraid patriarch"
#> [1] "meaty ausrine"
#> [1] "banana barnacle"
#> [1] "Scratchin’ Commander"

Hall of Fame Entries

This is an incomplete and running list of some of my favorite returns from this function. Because most of the sample output on the README is a one-off return, these are prone to disappear every time the README is updated. No matter, I want to preserve some of these, for posterity.



Try the codename package in your browser

Any scripts or data that you put into this service are public.

codename documentation built on Sept. 8, 2021, 1:08 a.m.