knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "80%", fig.align = "center", warning = FALSE )
library("badger")
cat( badge_cran_release("codename", "green"), badge_cran_download("codename", "grand-total", "green"), badge_cran_download("codename", "last-month", "green"), badge_cran_download("codename", "last-week", "green") )
{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), 'nicka' (in which code names are partly derived from conventions spelled out by the old U.S. NICKA system) 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.
You can install this on CRAN.
install.packages("codename")
You can also install the development version of this package through the {devtools}
package.
devtools::install_github("svmiller/codename")
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() # defaults to any codename() codename() codename() codename() codename(type = "gods") codename(type = "gods") codename(type = "gods") codename(type = "gods") codename(type = "nicka") codename(type = "nicka") codename(type = "nicka") codename(type = "nicka") codename(type = "ubuntu") codename(type = "ubuntu") codename(type = "ubuntu") codename(type = "ubuntu") codename(type = "wu-tang") codename(type = "wu-tang") codename(type = "wu-tang") codename(type = "wu-tang") variety_pack(seed = "A Reproducible Character Seed") variety_pack(seed = 8675309)
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.
{codename}
in the WildHere's a running list of projects that make use of {codename}
. If you would like your project included, please raise an issue on the project's Github.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.