-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
executable file
·225 lines (174 loc) · 8.49 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
---
output:
md_document:
variant: markdown_github
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# ggconf
[](https://travis-ci.org/caprice-j/ggconf)
[](https://ci.appveyor.com/project/caprice-j/ggconf)
[](https://codecov.io/gh/caprice-j/ggconf)
<!-- [](https://coveralls.io/github/caprice-j/ggbash) -->
[](https://codeclimate.com/github/caprice-j/ggconf/issues)
[](http://www.repostatus.org/#wip)
ggconf provides `theme2()`, a flexible `ggplot2::theme()` interface.
```{r, echo=FALSE}
library(ggplot2)
```
## Usage
```{r, eval=FALSE}
g <- ggplot(iris) + geom_point(aes(Sepal.Width, Sepal.Length))
g + theme2(ax.txt(sz=20, f="bold"),
ax.line(col='gray60', sz=2),
panel.bg(fill="white")
)
```
```{r example, echo=FALSE, eval=FALSE}
g <- ggplot(iris) + geom_point(aes(Sepal.Width, Sepal.Length))
g + theme( axis.text = element_text(size=20),
axis.line = element_line(colour="gray60", size=2),
panel.background = element_rect(fill="white"))
# gg iris + point Sepal.W Sepal.L col=Spec siz=Petal.W + theme text: size=20 face="bold"
```
The following ggplot2 command generates the same plot.
```{r, eval = FALSE}
g + ggplot2::theme(axis.text = element_text(size=20, face="bold"),
axis.line = element_line(colour="gray60", size=2),
panel.background = element_rect(fill="white")
)
```
## Getting Started
If you replace your `ggplot2::theme()` with `ggconf::theme2()`, ggconf would work.
All of the followings return the same plot, and you can use the style you prefer the most.
```r
g + theme( axis.text = element_text(size=20, face="bold")) # Style 1: ggplot2 default (50 characters)
g + theme2(axis.text = element_text(size=20, face="bold")) # Style 2: ggconf
g + theme2(axis.text(size=20, face="bold")) # Style 3: ggconf without element_text()
g + theme2(ax.txt(sz=20, face="bold")) # Style 4: ggconf shorter but readable
g + theme2(at(z=20, f="bold")) # Style 5: ggconf shortest (25 characters)
```
## Features
### Partial Match
Even if the unique identification is not possible for specified elements
(e.g. theme element names or arguments),
`ggconf` tries to execute its best estimate
instead of just returning an error.
For the input `theme2(ax.txt(sz=20, fc="bold"), ax.ln(c='gray60'), panel.bg(fill="white"))`,
ggconf performs partial matches six times.
* __theme element names__
+ `ax.txt` matches `axis.text`. You can even write `a.t` or `at`.
+ `ax.ln` matches `axis.line`. You can even write `a.l` or `al`.
+ `panel.bg` matches `panel.background`. You can even write `pnl.bg`.
+ `p.bg` matches `plot.background` according to edit distance.
* __theme configuration arguments__
+ `sz` or `z` match `size`.
+ `f` matches `face` (fontface).
+ `fill` needs to write not just `f` but `fi`.
+ `c` matches `colour`.
## Installation
```{r, eval=FALSE}
# install.packages("devtools")
devtools::install_github("caprice-j/ggconf")
```
+ If you get `no appender.console()` error,
please `install.packages('rly')`.
## Example
The goal of ggconf is to make it less stressful to finalize your plots.
#### Raw ggplot2 plot
The following plot uses the ggplot2 default appearance settings.
```{r, eval=FALSE}
suppressPackageStartupMessages(library(dplyr))
gg <- ggplot(mtcars[1:20, ] %>% tibble::rownames_to_column() %>%
mutate(car_name = rowname, maker = gsub(" .*", "", car_name) ) ) +
#geom_label(aes(mpg, qsec, label = substr(car_name, 1, 13), color=maker),
geom_point(aes(mpg, qsec, color=maker), size=8) +
geom_text(aes(mpg, qsec, label=substr(maker, 1, 2)), color="white", fontface="bold") +
labs(title = "Motor Trend Car Road Tests",
subtitle = "Top 20 rows are extracted for demonstration",
caption = "Source: 1974 Motor Trend US magazine") +
scale_x_continuous(breaks=seq(10,34, 4))
gg
```
```{r, echo=FALSE, eval=FALSE, fig.height=9, fig.width=10}
suppressPackageStartupMessages(library(dplyr))
gg <- ggplot(mtcars[1:20, ] %>% tibble::rownames_to_column() %>%
mutate(car_name = rowname, maker = gsub(" .*", "", car_name) ) ) +
#geom_label(aes(mpg, qsec, label = substr(car_name, 1, 13), color=maker),
geom_point(aes(mpg, qsec, color=maker), size=8) +
geom_text(aes(mpg, qsec, label=substr(maker, 1, 2)), color="white", fontface="bold") +
labs(title = "Motor Trend Car Road Tests",
subtitle = "Top 20 rows are extracted for demonstration",
caption = "Source: 1974 Motor Trend US magazine") +
scale_x_continuous(breaks=seq(10,34, 4))
gg
```
+ When we consider making a presentation, this plot has several issues:
- **Axis titles** and **numeric values** are too small to see through remote screen sharing (i.e. low-resolution)
- **Y-axis title** is rotated and does not jump out at you unless carefully looking at it
- **Title** and **subtitle** fonts are not aesthetically appealing
- Does not necessarily conform to company-specific styles (e.g. white background)
For resolving these issues, you would add the following `theme()` configurations:
```{r, eval=FALSE}
# If using ggplot2::theme():
gg + theme(
text = element_text(face="bold", size=24, family="Times New Roman"),
panel.background = element_rect(fill="white"),
legend.box.margin = margin(0.2,0.2,0.2,0.2,"cm"),
legend.box.background = element_rect(colour="black"),
legend.key = element_rect(fill="white"),
legend.position = "bottom",
legend.text = element_text(size=rel(0.8)),
legend.title = element_text(family="Consolas", colour="royalblue"),
axis.title = element_text(family="Consolas", colour="royalblue"),
axis.title.y = element_text(angle=0, vjust=0.5),
axis.text = element_text(size=rel(1.1)),
axis.line = element_line(arrow=arrow(type="open",angle=20), size=2),
axis.ticks = element_line(size=1),
axis.ticks.length = grid::unit(0.5,"cm"),
plot.subtitle = element_text(face="plain", hjust=1),
plot.margin = margin(0.3,0.3,0.3,0.1,"inch")
)
```
ggconf enables modifying these parameters with concice notations.
#### With ggconf
```{r, eval=FALSE}
gg +
theme2(
txt(f="bold", sz=24, family="Times New Roman"), # make all text thicker/larger
pnl.bg(fill="white"),
lgd.box.bg(c="black"),
lgd.box.margin(.2, .2, .2, .2, "cm"),
lgd.key(fill="white"),
lgd.pos("bottom"),
lgd.txt(z=rel(.8)),
lgd.title(family="Consolas", c="royalblue"), # equally-spaced font
axs.title(family="Consolas", c="royalblue"), # colorize axis titles
axs.title.y(angle=0, vjust=.5), # rotate and centerize y axis label
axs.txt(z=rel(1.1)),
axs.line(arrow=arrow(type="open", angle=20), z=2), #
axs.tick(sz=1), # tick or ticks? It doesn't matter
axs.tick.len(.5, "cm"),
plt.subtitle(f="plain", hjust=1),
plt.margin(.3, .3, .3, .1, "inch") # adjust margins
)
```
## Other Works
`ggconf` draws inspiration from some other higher level programming
languages including Bash, CoffeeScript, Lisp, and Ruby.
<!-- Fixit is inspired by [Fix-It Hints](http://clang.llvm.org/docs/InternalsManual.html#fix-it-hints) in clang C++ compiler. -->
## Current Implementation Status
ggconf is first released on August 24, 2017.
+ DONE:
+ version 0.1 : lightweight port from ggbash