diff --git a/DESCRIPTION b/DESCRIPTION index 6f813bf..15bf77f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -5,14 +5,17 @@ Version: 0.1.1 Date: 2016-04-06 Author: Tim Lucas Maintainer: Tim Lucas <timcdlucas@gmail.com> -Description: Use Pokemon(R) inspired palettes with additional 'ggplot2' scales. Palettes are the colours in each Pokemon's sprite, ordered by how common they are in the image. The first 386 Pokemon are currently provided. +Description: Use Pokemon(R) inspired palettes with additional 'ggplot2' scales. + Palettes are the colours in each Pokemon's sprite, ordered by how common + they are in the image. The first 386 Pokemon are currently provided. Suggests: - ggplot2, - magrittr + ggplot2, + magrittr Imports: - grDevices, - stats, - graphics + grDevices, + stats, + graphics License: MIT + file LICENSE Copyright: Pokemon, pokedex and all pokemon names are trademarks of Nintendo. URL: https://github.com/timcdlucas/palettetown +RoxygenNote: 5.0.1 diff --git a/NAMESPACE b/NAMESPACE index e099460..3dc4dcc 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,4 +1,4 @@ -# Generated by roxygen2 (4.1.1): do not edit by hand +# Generated by roxygen2: do not edit by hand export(ichooseyou) export(pokedex) diff --git a/man/ichooseyou.Rd b/man/ichooseyou.Rd index bf569b5..ecfb571 100644 --- a/man/ichooseyou.Rd +++ b/man/ichooseyou.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/palettetown.R \name{ichooseyou} \alias{ichooseyou} @@ -13,15 +13,15 @@ ichooseyou(pokemon = 1, spread = NULL) } \description{ Get a pokemon palette by either giving a pokemon number or name. -The recomended syntax for this function is +The recomended syntax for this function is 'Magikarp' \%>\% ichooseyou using the pipe operator \%>\% from the magrittr package. To specify the \code{spread} parameter use 'Snorlax' \%>\% ichooseyou(5) } \details{ -If \code{spread} is given an integer, the full palette is - clustered into that many groups (ward clustering in HSV space). +If \code{spread} is given an integer, the full palette is + clustered into that many groups (ward clustering in HSV space). The most common colour in each cluster is then returned. It is hoped this will give a good balance between reflecting the pokemons colouring while giving relatively distinct colours. @@ -30,6 +30,7 @@ If \code{spread} is given an integer, the full palette is library(magrittr) pal <- 'Hoothoot' \%>\% ichooseyou pal2 <- 'Pichu' \%>\% ichooseyou(6) + } \seealso{ \code{\link{pokepal}} diff --git a/man/palettetown.Rd b/man/palettetown.Rd index 6b338d2..e65aeca 100644 --- a/man/palettetown.Rd +++ b/man/palettetown.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/palettetown.R \docType{package} \name{palettetown} diff --git a/man/pokedex.Rd b/man/pokedex.Rd index 08966fb..eb03640 100644 --- a/man/pokedex.Rd +++ b/man/pokedex.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/pokedex.R \name{pokedex} \alias{pokedex} @@ -11,9 +11,9 @@ pokedex(pokemon = NULL, spread = NULL, cb = NULL) \item{spread}{How many, quite distinct, colours should be returned. See details.} -\item{cb}{A number between 1 and 4 to select ten of 40 colourblind friendly - (Deuteranomaly) palettes. \code{pokemon} is ignored if used, but \code{spread} - works as normal.} +\item{cb}{A number between 1 and 4 to select ten of 40 colourblind friendly +(Deuteranomaly) palettes. \code{pokemon} is ignored if used, but \code{spread} +works as normal.} } \description{ Display 10 pokemon palettes starting from a name or number. @@ -21,8 +21,8 @@ If no name or number is given, 10 of the better palettes are displayed. Pokedex is a Trademark of Nintendo. } \details{ -If \code{spread} is given an integer, the full palette is - clustered into that many groups (ward clustering in HSV space). +If \code{spread} is given an integer, the full palette is + clustered into that many groups (ward clustering in HSV space). The most common colour in each cluster is then returned. It is hoped this will give a good balance between reflecting the pokemons colouring while giving relatively distinct colours. diff --git a/man/pokepal.Rd b/man/pokepal.Rd index 64d2e7f..cfe7f60 100644 --- a/man/pokepal.Rd +++ b/man/pokepal.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/palettetown.R \name{pokepal} \alias{pokepal} @@ -15,9 +15,9 @@ pokepal(pokemon = 1, spread = NULL) Get a pokemon (R) palette by either giving a pokemon number or name. } \details{ -If \code{spread} is given an integer, the full palette is +If \code{spread} is given an integer, the full palette is clustered into that many groups (ward clustering in HSV space, using - only hue and downweighted saturation). + only hue and downweighted saturation). The most common colour in each cluster is then returned. It is hoped this will give a good balance between reflecting the pokemons colouring while giving relatively distinct colours. diff --git a/man/scale_colour_poke.Rd b/man/scale_colour_poke.Rd index 5db1e9f..2eca18a 100644 --- a/man/scale_colour_poke.Rd +++ b/man/scale_colour_poke.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/ggplot2scales.R \name{scale_colour_poke} \alias{scale_color_poke} @@ -14,7 +14,7 @@ scale_color_poke(..., pokemon = 1, spread = NULL) } \arguments{ \item{...}{Other arguments passed on to \code{discrete_scale} to control - name, limits, breaks, labels and so forth.} +name, limits, breaks, labels and so forth.} \item{pokemon}{An integer or character pokemon name} @@ -24,8 +24,8 @@ scale_color_poke(..., pokemon = 1, spread = NULL) Get a pokemon palette by either giving a pokemon number or name. } \details{ -If \code{spread} is given an integer, the full palette is - clustered into that many groups (ward clustering in HSV space). +If \code{spread} is given an integer, the full palette is + clustered into that many groups (ward clustering in HSV space). The most common colour in each cluster is then returned. It is hoped this will give a good balance between reflecting the pokemons colouring while giving relatively distinct colours.