-
Notifications
You must be signed in to change notification settings - Fork 22
/
README.Rmd
90 lines (63 loc) · 3.72 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
---
output: github_document
editor_options:
chunk_output_type: console
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
message=FALSE, warning=FALSE
)
```
<!-- badges: start -->
[](https://cran.r-project.org/package=ggmosaic) [](https://www.r-pkg.org/pkg/ggmosaic)
[](https://github.com/haleyjeppson/ggmosaic/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
# ggmosaic <img src="man/figures/logo.png" align="right" width="120" />
ggmosaic was designed to create visualizations of categorical data and is capable of producing bar charts, stacked bar charts, mosaic plots, and double decker plots.
## Installation
You can install ggmosaic from github with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("haleyjeppson/ggmosaic")
```
## Example
```{r example}
library(ggmosaic)
library(dplyr)
happy %>%
mutate(finrela = forcats::fct_recode(finrela,
"far below " = "far below average",
" below" = "below average",
"average" = "average",
"above " = "above average",
"l\n far above" = "far above average")) %>%
ggplot() +
geom_mosaic(aes(x = product(finrela), fill=health), show.legend = FALSE) +
theme_mosaic() +
scale_fill_manual(values = c("#4575B4", "#ABD9E9", "#FEE090", "#F46D43"))
```
## geom_mosaic: setting the aesthetics
In `geom_mosaic()`, the following aesthetics can be specified:
- `weight`: select a weighting variable
- `x`: select variables to add to formula
- declared as `x = product(var2, var1, ...)`
- `alpha`: add an alpha transparency to the selected variable
- unless the variable is called in `x`, it will be added to the formula in the first position
- `fill`: select a variable to be filled
- unless the variable is called in `x`, it will be added to the formula in the first position after the optional `alpha` variable.
- `conds` : select a variable to condition on
- declared as `conds = product(cond1, cond2, ...)`
These values are then sent through repurposed `productplots` functions to create the desired formula: `weight ~ alpha + fill + x | conds`.
## Version compatibility issues with ggplot2
Since the initial release of ggmosaic, ggplot2 has evolved considerably. And as ggplot2 continues to evolve, ggmosaic must continue to evolve alongside it. Although these changes affect the underlying code and not the general usage of ggmosaic, the general user may need to be aware of compatibility issues that can arise between versions. The table below summarizes the compatibility between versions.
| ggmosaic | ggplot2 | Axis labels | Tick marks |
|----------|---------|-------------------------------------------------------------------------------|---------------|
| 0.3.3 | 3.3.3 | x | x |
| 0.3.0 | 3.3.0 | x | x |
| 0.2.2 | 3.3.0 | Default labels are okay, but must use <br>`scale_*_productlist()` to modify | No tick marks |
| 0.2.2 | 3.2.0 | Default labels okay, but must use <br>`scale_*_productlist()` to modify | x |
| 0.2.0 | 3.2.0 | Default labels are wrong, but can use <br>`labs()` to modify | x |