README.Rmd

---
output: github_document
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "80%",
  fig.align = "center",
  warning = FALSE
)
```

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

```{r echo=FALSE, results="hide", message=FALSE}
library("badger")
```

```{r, echo = FALSE, results='asis'}
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.

# Installation

You can install this on CRAN.

```r
install.packages("codename")

```

You can also install the development version of this package through the `{devtools}` package.

```r
devtools::install_github("svmiller/codename")
```

# Usage

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

```{r}
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)
```


# 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.

- electric lime agenda
- second-hand shovel
- reckless azimuth
- x-pert anesthesiology
- sunny sunroom
- improbable boris
- criminal outlaw
- gregarious denominator
- lawn green insurgence
- corrupt chickadee
- realistic democrat
- creamy escalator
- recent prior
- sapphire guacamole
- deserted samurai
- subtle girlfriend
- critical father
- short-term opposition
- favorite weakness
- lavender pawnshop
- pungent pigeon
- gifted gerbil
- guilty gorilla
- sniveling snail
- foolish soma
- sizzling sawfish
- butter bug

# `{codename}` in the Wild

Here's a running list of projects that make use of `{codename}`. If you would like your project included, please [raise an issue](https://github.com/svmiller/codename/issues) on the project's Github.

- [**corrupt caterpillar**](https://github.com/andrewheiss/corrupt-caterpillar)