treemaps.qmd

# Treemaps {#sec-treemaps}

```{r}
#| label: setup
#| message: false
#| warning: false
#| include: false
library(tidyverse)
library(lubridate)
library(scales)
library(knitr)
library(kableExtra)
library(colorblindr)
library(downlit)
# fonts ----
library(extrafont)
library(sysfonts)
source("_common.R")
# use font
showtext::showtext_auto()
# set theme
ggplot2::theme_set(theme_ggp2g(
    base_size = 15))
# pak::pak("wilkox/treemapify")
library(treemapify)
```

```{r}
#| label: status
#| results: "asis"
#| echo: false
# status ----
# polish, dev, draft, complete
status("complete")
```

:::: {.callout-note collapse="false" icon=false}

<br>

```{r}
#| label: full_code_display
#| eval: true
#| echo: false
#| warning: false
#| message: false
#| out-height: '60%'
#| out-width: '60%'
#| fig-align: right
library(treemapify) 
library(palmerpenguins)
library(ggplot2)
treemap_peng <- penguins |> 
                  select(species, island, sex) |> 
                  tidyr::drop_na() |> 
                  group_by(species, island, sex) |>
  count(species, island, sex) |> 
  ungroup()
labs_treemap <- labs(
  title = "Adult foraging penguins",
    fill = "Sex")
ggp2_treemap <- ggplot(treemap_peng, 
       aes(area = n, 
           fill = sex, 
           label = sex,
           subgroup = species,
           subgroup2 = island)) +
       treemapify::geom_treemap() +
       treemapify::geom_treemap_text(
           place = "bottomright",
           color = "#d0d0d0",
           min.size = 0,
           alpha = 0.90,
           fontface = "italic",
           family = "sans") 
ggp2_tm_subgroup <- ggp2_treemap +
    treemapify::geom_treemap_subgroup2_border(
           color = "#02577A",
           size = 4.0) + 
       treemapify::geom_treemap_subgroup2_text(
           place = "center",
           alpha = 0.65,
           color = "#02577A",
           min.size = 0,
           family = "sans")
ggp2_tm_subgroup2 <- ggp2_tm_subgroup + 
       treemapify::geom_treemap_subgroup_border(
           color = "#ffffff", 
           size = 4) + 
       treemapify::geom_treemap_subgroup_text(
           place = "topleft",
           alpha = 0.65,
           grow = TRUE,
           color = "#ffffff",
           min.size = 0,
           family = "mono",
           fontface = "bold")

ggp2_tm_subgroup2 + 
  labs_treemap
```

::: {style="font-size: 1.10em; color: #02577A;"}
**This graph requires:**
:::

::: {style="font-size: 1.05em; color: #282b2d;"}
**`r emo::ji("check")` at least two categorical variables**     
:::

::: {style="font-size: 1.05em; color: #282b2d;"}
**`r emo::ji("check")` a numeric variable of counts (for each level of the categorical variables)**
:::

::::

## Description 

Treemaps display proportionally divided rectangular hierarchies for levels of categorical variables. The layout consists of 'squarified' tiles, which display the relative contribution of each categorical value to the overall graph space. 

We'll build a treemap using the [`treemapify` package.](http://wilkox.org/treemapify/) Also check out [mosaic plots](https://mjfrigaard.github.io/ggp2-gallery/prp/mosaic_plot.html).

## Set up

::: {style="font-size: 1.15em; color: #1e83c8;"}
**PACKAGES:**
:::

Install packages.

::: {style="font-size: 0.85em;"}
```{r}
#| label: pkg_code_treemap
#| code-fold: show
#| eval: false
#| echo: true
#| warning: false
#| message: false
#| results: hide
# pak::pak("wilkox/treemapify")
# install.packages("palmerpenguins")
library(treemapify) 
library(palmerpenguins)
library(ggplot2)
```
:::



::: {style="font-size: 1.15em; color: #1e83c8;"}
**DATA:**
:::

::: {.column-margin}
![Artwork by Allison Horst](www/lter_penguins.png){fig-align="right" width="100%" height="100%"}
:::


Filter the missing values from `sex`, group the data by `species`, `island`, and `sex`, then count the `species` and `island` (then `ungroup()`).

::: {style="font-size: 0.85em;"}
```{r}
#| label: data_code_treemap
#| code-fold: show
#| eval: true
#| echo: true
treemap_peng <- penguins |> 
    dplyr::select(species, island, sex) |>
    tidyr::drop_na() |>
    dplyr::group_by(species, island, sex) |>
    dplyr::count(species, island, sex) |>
    ungroup()
glimpse(treemap_peng)
```
:::

## Grammar


::: {style="font-size: 1.15em; color: #1e83c8;"}
**CODE:**
:::


  -   Create labels with `labs()`

  -   Initialize the graph with `ggplot()` and provide `data`

  -   Map the `n` to `area`, `sex` to `fill` and `label`, `species` to `subgroup`, and `island` to `subgroup2`

  -   Add `geom_treemap()`

  -   Add `geom_treemap_text()`   

      - `place`: this controls where the boxes start  
      
      - `color`: text color    
      
      - `min.size`: the minimum font size (when re-sizing)    
      
      - `alpha`: opacity      
      
      - `fontface`: `itlalic`/`bond`    
      
      - `family`: `"sans"`/`"sansserif"`/`"mono"`  

::: {style="font-size: 0.85em;"}
```{r}
#| label: code_graph_treemap
#| code-fold: show
#| eval: false
#| echo: true 
#| warning: false
#| message: false
#| out-height: '100%'
#| out-width: '100%'
labs_treemap <- labs(
  title = "Adult foraging penguins",
    fill = "Sex")
ggp2_treemap <- ggplot(treemap_peng, 
       aes(area = n, 
           fill = sex, 
           label = sex,
           subgroup = species,
           subgroup2 = island)) +
       treemapify::geom_treemap() +
       treemapify::geom_treemap_text(
           place = "bottomright",
           color = "#d0d0d0",
           min.size = 0,
           alpha = 0.90,
           fontface = "italic",
           family = "sans") 
ggp2_treemap + 
  labs_treemap
```
:::



::: {style="font-size: 1.15em; color: #1e83c8;"}
**GRAPH:**
:::

::: {style="font-size: 0.85em;"}
```{r}
#| label: create_graph_treemap
#| eval: true
#| echo: true 
#| warning: false
#| message: false
#| out-height: '100%'
#| out-width: '100%'
#| layout-nrow: 1
#| column: page-inset-right
labs_treemap <- labs(
  title = "Adult foraging penguins",
    fill = "Sex")
ggp2_treemap <- ggplot(treemap_peng, 
       aes(area = n, 
           fill = sex, 
           label = sex,
           subgroup = species,
           subgroup2 = island)) +
       treemapify::geom_treemap() +
       treemapify::geom_treemap_text(
           place = "bottomright",
           color = "#d0d0d0",
           min.size = 0,
           alpha = 0.90,
           fontface = "italic",
           family = "sans") 
ggp2_treemap + 
  labs_treemap
```
:::

## More info

`treemapify` has multiple options for building treemaps. We cover a few of these below, but you should check out the [package vignette](https://cran.r-project.org/web/packages/treemapify/vignettes/introduction-to-treemapify.html). 

### Subgroup 

`ggplot2` build layers in the order they're written, so it's [advised](https://cran.r-project.org/web/packages/treemapify/vignettes/introduction-to-treemapify.html) to build the subgroups in order from "*from deepest to shallowest*", with `subgroups2` first (ending on `subgroup`)

- Add `geom_treemap_subgroup2_border()`

  - Set the `size` and `color`  

- Add `geom_treemap_subgroup2_text()`

  - `place`: this controls where the boxes start    
  
  - `color`: text color    
  
  - `min.size`: the minimum font size (when re-sizing)   
  
  - `alpha`: opacity      
  
  - `fontface`: `itlalic`/`bond`    
  
  - `family`: `"sans"`/`"sansserif"`/`"mono"`  


See full list of arguments [here](http://wilkox.org/treemapify/).

::: {style="font-size: 0.85em;"}
```{r}
#| label: code_graph_treemap_sgb
#| eval: true
#| echo: true 
#| warning: false
#| message: false
#| out-height: '100%'
#| out-width: '100%'
#| layout-nrow: 1
#| column: page-inset-right
ggp2_tm_subgroup <- ggp2_treemap +
    treemapify::geom_treemap_subgroup2_border(
           color = "#02577A",
           size = 4.0) + 
       treemapify::geom_treemap_subgroup2_text(
           place = "center",
           alpha = 0.65,
           color = "#02577A",
           min.size = 0,
           family = "sans")
ggp2_tm_subgroup +
  labs_treemap
```
:::

### Subgroup 2

  - Add `geom_treemap_subgroup_border()`
  
    - Set the `size` and `color`    

  - Add `geom_treemap_subgroup_text()`

    - `place`: this controls where the boxes start  
    
    - `color`: text color    
    
    - `min.size`: the minimum font size (when re-sizing)   
    
    - `alpha`: opacity      
    
    - `fontface`: `itlalic`/`bond`    
    
    - `family`: `"sans"`/`"sansserif"`/`"mono"` 

::: {style="font-size: 0.85em;"}
```{r}
#| label: code_graph_tmap_sgb_2
#| eval: true
#| echo: true 
#| warning: false
#| message: false
#| out-height: '100%'
#| out-width: '100%'
#| layout-nrow: 1
#| column: page-inset-right
ggp2_tm_subgroup2 <- ggp2_tm_subgroup + 
       treemapify::geom_treemap_subgroup_border(
           color = "#ffffff", 
           size = 4) + 
       treemapify::geom_treemap_subgroup_text(
           place = "topleft",
           alpha = 0.65,
           grow = TRUE,
           color = "#ffffff",
           min.size = 0,
           family = "mono",
           fontface = "bold")

ggp2_tm_subgroup2 + 
  labs_treemap
```
:::