forked from r-lib/gtable
/
README.Rmd
93 lines (71 loc) · 3.03 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
set.seed(42L)
options(width = 90)
```
# gtable <img src="man/figures/logo.png" align="right"/>
[](https://travis-ci.org/r-lib/gtable)
[](http://cran.r-project.org/package=gtable)
[](https://codecov.io/github/r-lib/gtable?branch=master)
[](https://www.tidyverse.org/lifecycle/#stable)
gtable is a layout engine built on top of the grid package. It is used to abstract away the creation of (potentially nested) grids of viewports into which graphic objects can be placed. gtable makes it easy to ensure alignment of graphic elements and piecemeal compositions of complex graphics. gtable is the layout engine powering [ggplot2](https://ggplot2.tidyverse.org) and is thus used extensively by many plotting functions in R without being called directly.
## Installation
You can install the released version of gtable from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("gtable")
```
or use the remotes package to install the development version from [GitHub](https://github.com/r-lib/gtable)
```r
# install.packages("remotes")
remotes::install_github("r-lib/gtable")
```
## Example
ggplot2 uses gtable for laying out plots, and it is possible to access the gtable representation of a plot for inspection and modification:
```{r, message=FALSE}
library(gtable)
library(ggplot2)
p <- ggplot(mtcars, aes(mpg, disp)) + geom_point()
p_table <- ggplotGrob(p)
p_table
```
A gtable object is a collection of graphic elements along with their placement in the grid and the dimensions of the grid itself. Graphic elements can span multiple rows and columns in the grid and be gtables themselves allowing for very complex automatically arranging layouts.
A gtable object is itself a grob, and can thus be drawn using standard functions from the grid package:
```{r}
library(grid)
grid.draw(p_table) # alternative use plot(p_table)
```
While most people will interact with gtable through ggplot2, it is possible to build a plot from the ground up.
```{r}
# Construct some graphical elements using grid
points <- pointsGrob(
x = runif(10),
y = runif(10),
size = unit(runif(10), 'cm')
)
xaxis <- xaxisGrob(at = c(0, 0.25, 0.5, 0.75, 1))
yaxis <- yaxisGrob(at = c(0, 0.25, 0.5, 0.75, 1))
# Setup the gtable layout
plot <- gtable(
widths = unit(c(1.5, 0, 1, 0.5), c('cm', 'cm', 'null', 'cm')),
heights = unit(c(0.5, 1, 0, 1), c('cm', 'null', 'cm', 'cm'))
)
# Add the grobs
plot <- gtable_add_grob(
plot,
grobs = list(points, xaxis, yaxis),
t = c(2, 3, 2),
l = c(3, 3, 2),
clip = 'off'
)
# Plot
grid.draw(plot)
```