README.Rmd

palettetown
======

[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/palettetown)](http://cranlogs.r-pkg.org/badges/grand-total/palettetown/index.html)
[![Build Status](https://travis-ci.org/timcdlucas/palettetown.svg)](https://travis-ci.org/timcdlucas/palettetown)

An R package providing pokemon colour palettes.

This package is very much inspired by [pokepalletes](http://pokepalettes.com/#charizard).

Note that Pokemon, pokedex and all pokemon names are trademarks of Nintendo. I own nothing.



Installation
-------------

### To install from CRAN
```{r installCRAN, echo = TRUE, eval = FALSE}
install.packages('palettetown')
library(palettetown)
```

### To install development version
```{r install, echo = TRUE, eval = FALSE}
library(devtools)
install_github('timcdlucas/palettetown')
library(palettetown)
```

Usage
------

### See palettes

```{r lib, eval = TRUE, echo = FALSE}
library(palettetown)
set.seed(10)
```

```{r pokedex, eval = TRUE, echo = TRUE}
# Show ten of the better palettes
pokedex()

# Show ten palettes starting from pokemon #155
# Get 7 fairly distinct colours for each.
pokedex(155, 7)

# Show ten palettes starting from Metapod
pokedex('Metapod')

# Show ten palettes that are fairly colour blind friendly
pokedex(cb = 1)

```


### Base graphics

```{r base}
plot(rnorm(20), rnorm(20), col = pokepal(pokemon = 137, spread = 6), pch = 16, cex = 1.8)
```

### ggplot2
```{r ggplot2}
# palettetown doesn't import ggplot2
library(ggplot2)


qplot(Sepal.Length, Sepal.Width, colour = Species, data=iris, size = 2) +
  scale_colour_poke(pokemon = 156, spread = 3)

qplot(factor(carb), data=mtcars, geom="bar", 
  fill = factor(carb)) +
  scale_fill_poke(pokemon = 'Quilava', spread = 6)
```