README.Rmd

---
title: "SailorMoonR 🌙"
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(
  echo = TRUE,
  collapse = TRUE,
  comment = '>',
  fig.path = "figures/",
  fig.height = 1
  )
```

![](figures/skyline.jpg)


Transform your R plots and graphics with the magical colors of Sailor Moon! 🌙✨🌸

## Installation


```r
install.packages("devtools") #If you don't already have devtools installed

devtools::install_github("morgansleeper/SailorMoonR")
```


![](figures/luna.gif)


## Using SailorMoonR

```{r, usage1}
#Load SailorMoonR
library(SailorMoonR)
```

__Functions:__  

* `MoonPaletteEnumeration`: list all available palettes
* `MoonPaletteIllumination()`: generate a sample swatch for a palette
* `inthenameofthemoon()`: use a palette (by having it return its color values)

```{r, usage2, fig.height=1, fig.width=5}
# See all available palettes
MoonPaletteEnumeration

# See a sample swatch for a palette
MoonPaletteIllumination("MoonPrismPower")
# Use a palette
inthenameofthemoon("MoonPrismPower")
```



__Prism:__

If you need more colors than a given palette offers, you can generate a larger palette by adding the `prism` argument:


```{r, usage3, fig.height=1, fig.width=5}
#Expand a palette with prism
inthenameofthemoon("CrescentBeam", prism=6)

MoonPaletteIllumination("MinatoSunset", prism=128)
```




## Palettes
```{r, palettes, fig.height=1, fig.width=5, include=FALSE}
MoonPaletteIllumination("MoonPrismPower")
MoonPaletteIllumination("MoonTiaraAction")
MoonPaletteIllumination("MoonHealingEscalation")
MoonPaletteIllumination("MoonPrincessHalation")
MoonPaletteIllumination("ShabonSpray")
MoonPaletteIllumination("ShineAquaIllusion")
MoonPaletteIllumination("AkuryoTaisan")
MoonPaletteIllumination("FireSoul")
MoonPaletteIllumination("SparklingWidePressure")
MoonPaletteIllumination("JupiterOakEvolution")
MoonPaletteIllumination("VenusLoveMeChain")
MoonPaletteIllumination("CrescentBeam")
MoonPaletteIllumination("MinatoDaylight")
MoonPaletteIllumination("MinatoSunset")
MoonPaletteIllumination("MinatoMoonlight")
MoonPaletteIllumination("TokyoTower")
```

### Sailor Moon  🌙


```r
inthenameofthemoon("MoonPrismPower")
```

![](figures/palettes-1.png)

```r
inthenameofthemoon("MoonTiaraAction")
```

![](figures/palettes-2.png)

```r
inthenameofthemoon("MoonHealingEscalation")
```

![](figures/palettes-3.png)

```r
inthenameofthemoon("MoonPrincessHalation")
```

![](figures/palettes-4.png)

### Sailor Mercury ☿

```r
inthenameofthemoon("ShabonSpray")
```

![](figures/palettes-5.png)

```r
inthenameofthemoon("ShineAquaIllusion")
```

![](figures/palettes-6.png)

### Sailor Mars ♂️

```r
inthenameofthemoon("AkuryoTaisan")
```

![](figures/palettes-7.png)

```r
inthenameofthemoon("FireSoul")
```

![](figures/palettes-8.png)

### Sailor Jupiter ♃

```r
inthenameofthemoon("SparklingWidePressure")
```

![](figures/palettes-9.png)

```r
inthenameofthemoon("JupiterOakEvolution")
```

![](figures/palettes-10.png)

### Sailor Venus  ♀️


```r
inthenameofthemoon("VenusLoveMeChain")
```

![](figures/palettes-11.png)

```r
inthenameofthemoon("CrescentBeam")
```

![](figures/palettes-12.png)


### Tokyo   🌃


```r
inthenameofthemoon("MinatoDaylight")
```

![](figures/palettes-13.png)

```r
inthenameofthemoon("MinatoSunset")
```

![](figures/palettes-14.png)


```r
inthenameofthemoon("MinatoMoonlight")
```

![](figures/palettes-15.png)


```r
inthenameofthemoon("TokyoTower")
```

![](figures/palettes-16.png)


## Examples


### ggplot2 📊

```r
library(ggplot2)

ggplot(distances, aes(x=Planet, y=Distance, fill=Planet)) +
  geom_col() +
  xlab("") + ylab("Distance from Sun (AU)") +
  scale_fill_manual(values = inthenameofthemoon("MoonTiaraAction")) +
  guides(fill=FALSE)
```

![](figures/distances.png)

### leaflet 🗺

```r
library(leaflet)

#Set up color palette
pal <- colorFactor(palette = (col=(inthenameofthemoon("MoonPrismPower"))), domain = locs$Type)

#Draw map
leaflet(locs) %>%
  addProviderTiles(providers$CartoDB.Positron) %>%
  addMarkers(label=~Name) %>%
  addCircles(radius=150, weight=1, color=~pal(Type)) %>%
  addLegend("topright", pal = pal, values = ~locs$Type, title = "Location type", opacity = .4) %>%
  addMiniMap("bottomright", width=100, height=100, tiles = providers$CartoDB.Positron)
```

![](figures/leaflet.png)


### seewave 🌊

```r
library(seewave)

spectro(tico, palette=colorRampPalette(inthenameofthemoon("MinatoSunset")),
  collevels=seq(-50,0,1), osc=TRUE, flim=c(2,6), tlim=c(0.5,1.4), heights=c(4,2))
```

![](figures/tico.png)


### image 🌋

```r
image(volcano, col=inthenameofthemoon("MinatoMoonlight", prism=32), axes=FALSE)
title(sub="Maungawhau", family = "sans", line=0.5, font.sub=2, cex.sub=1.2)
```

![](figures/maungawhau.png)

## Acknowledgments & extras

Project inspired by Karthik Ram's [Wes Anderson Palettes](https://github.com/karthik/wesanderson) package.  

Written using and pairs nicely with sailorhg's [fairyfloss](https://github.com/sailorhg/fairyfloss) theme (RStudio version available [here](https://github.com/gadenbuie/rsthemes)).

_Sailor Moon © Naoko Takeuchi._