readme.Rmd

---
title: "" 
output: github_document
---

```{r echo=FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  echo=FALSE,
  message = FALSE,
  warning = FALSE,
  error = FALSE,
  comment = "#>",
  fig.height = 1
)
```

<img align="left" height = "300" width = "300" src="images/0-logo.png">


# soilpalettes  

<!-- badges: start -->
[![DOI](https://zenodo.org/badge/257353182.svg)](https://zenodo.org/badge/latestdoi/257353182)
  [![R build status](https://github.com/kaizadp/soilpalettes/workflows/R-CMD-check/badge.svg)](https://github.com/kaizadp/soilpalettes/actions)
  <!-- badges: end -->

This package contains color palettes for RStudio, inspired by soil profiles.
Palettes are colorblind-friendly and were created using [Chroma.js](https://gka.github.io/palettes/) and [Coolors](https://coolors.co).  


Source images and color hex values can be found in the  [`images.md`](https://github.com/kaizadp/soilpalettes/blob/master/images.md) file in the root directory. 

---

### install package

```{r echo = TRUE, message=FALSE,warning=FALSE}
# install.packages("devtools") 
devtools::install_github("kaizadp/soilpalettes")
```

----

<details>
  <summary>Palettes</summary>
  
#### soil orders, suborders, and great groups
```{r orders, echo = FALSE}
library(soilpalettes)

soil_palette(name="alaquod",5)
soil_palette(name="durorthod",5)
soil_palette(name="eutrostox",5)
soil_palette(name="natrudoll",5)
soil_palette(name="paleustalf",5)
soil_palette(name="podzol",5)
soil_palette(name="rendoll",5)
soil_palette(name="vitrixerand",5)


```

#### soil series
```{r series, echo = FALSE}
soil_palette(name="bangor",5)
soil_palette(name="pywell",5)
```

#### others

```{r misc, echo = FALSE}
soil_palette(name="redox",5)
soil_palette(name="redox2",5)
soil_palette(name="crait",5)
soil_palette(name="gley",5)

```

----

</details>

<details>
  <summary>Examples</summary>
```{r usage1, fig.height=4, fig.width=5, echo=TRUE}
library(ggplot2)

ggplot(data=iris, aes(x=Sepal.Width, fill = Species))+
  geom_histogram(binwidth=0.2, color="black") + 
  xlab("Sepal Width") +  ylab("Frequency") + 
  ggtitle("Histogram of Sepal Width") + theme_bw()+
  
  scale_fill_manual(values = soil_palette("rendoll",3))
```

```{r usage2, fig.height=4, fig.width=5, echo=TRUE}
ggplot(data=iris, aes(x=Sepal.Width, fill=Species)) + 
  geom_density(stat="density", alpha=(0.6)) +
  xlab("Sepal Width") +  ylab("Density") + 
  ggtitle("Histogram & Density Curve of Sepal Width") + theme_bw()+
  
  scale_fill_manual(values = soil_palette("paleustalf",3))

```

```{r usage3, fig.height=4, fig.width=5, echo=TRUE}
library(palmerpenguins)

ggplot(penguins, aes(x = bill_length_mm, y = bill_depth_mm, color = species))+
  geom_point()+ 
  labs(x = "Bill length (mm)", y = "Bill depth (mm)",
       title = "Scatterplot of penguin bill dimensions",
       subtitle = "data = Palmer Penguins")+
  theme_bw()+
  
  scale_color_manual(values = soil_palette("paleustalf", 3)) 
```

```{r usage4, fig.height=4, fig.width=5, echo=TRUE}
ggplot(penguins, aes(y = body_mass_g, x = species, fill = species))+
  geom_violin(alpha = 0.5)+ 
  geom_dotplot(binaxis = "y", color = "black", fill="black", dotsize=0.3, stackdir = "center", binpositions="all")+
  labs(y = "Body mass (g)", x = "",
       title = "Violin plot of penguin body mass",
       subtitle = "data = Palmer Penguins")+
  theme_bw()+
  
  scale_fill_manual(values = soil_palette("podzol", 3)) 
```

```{r usage5, fig.height=4, fig.width=5, echo=TRUE}
ggplot(penguins, aes(x = bill_length_mm, y = bill_depth_mm, color = bill_length_mm))+
  geom_point()+ 
  labs(x = "Bill length (mm)", y = "Bill depth (mm)",
       title = "Scatterplot of penguin bill dimensions",
       subtitle = "data = Palmer Penguins")+
  theme_bw()+
  
  scale_color_gradientn(colors = rev(soil_palette("redox2",5))) 
```
</details>


<details>
  <summary>Acknowledgments and Contributions</summary>
  
Code structure was modelled after the [`PNWColors`](https://github.com/jakelawlor/PNWColors) and [`wesanderson`](https://github.com/karthik/wesanderson) packages.  
Contribute soil palettes in the [issues](https://github.com/kaizadp/soilpalettes/issues/6).

</summary>