-
Notifications
You must be signed in to change notification settings - Fork 37
/
README.Rmd
167 lines (114 loc) · 6.62 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
---
output: github_document
---
```{r setup, include=FALSE}
library(webshot)
```
webshot
=======
<!-- badges: start -->
[](https://github.com/wch/webshot/actions)
<!-- badges: end -->
**Note:** webshot uses PhantomJS, which is a headless browser that stopped development in 2018. Please use [webshot2](https://github.com/rstudio/webshot2), which uses Chromium-based browsers.
**Webshot** makes it easy to take screenshots of web pages from R. It can also:
* Run Shiny applications locally and take screenshots of the application.
* Render R Markdown documents and take screenshots of the document. Webshot can handle both static Rmd documents and interactive ones (those with `runtime: shiny`).
See the [introduction article](https://wch.github.io/webshot/articles/intro.html) for examples in addition to the ones below.
## Installation
Webshot can be installed from CRAN. Webshot also requires the external program [PhantomJS](https://phantomjs.org/). You may either download PhantomJS from its website, or use the function `webshot::install_phantomjs()` to install it automatically.
```{r eval=FALSE}
install.packages("webshot")
webshot::install_phantomjs()
```
## Usage
By default, `webshot` will use a 992x744 pixel viewport (a virtual browser window) and take a screenshot of the entire page, even the portion outside the viewport.
```{r eval=FALSE}
library(webshot)
webshot("https://www.r-project.org/", "r.png")
webshot("https://www.r-project.org/", "r.pdf") # Can also output to PDF
```
You can clip it to just the viewport region:
```{r eval=FALSE}
webshot("https://www.r-project.org/", "r-viewport.png", cliprect = "viewport")
```
You can also get screenshots of a portion of a web page using CSS selectors. If there are multiple matches for the CSS selector, it will use the first match.
```{r eval=FALSE}
webshot("https://www.r-project.org/", "r-sidebar.png", selector = ".sidebar")
```
If you supply multiple CSS selectors, it will take a screenshot containing all of the selected items.
```{r eval=FALSE}
webshot("https://www.r-project.org/", "r-selectors.png",
selector = c("#getting-started", "#news"))
```
The clipping rectangle can be expanded to capture some area outside the selected items:
```{r eval=FALSE}
webshot("https://www.r-project.org/", "r-expand.png",
selector = "#getting-started",
expand = c(40, 20, 40, 20))
```
You can take higher-resolution screenshots with the `zoom` option. This isn't exactly the same as taking a screenshot with a HiDPI ("Retina") device: it is like increasing the zoom to 200% in a desktop browser and doubling the height and width of the browser window. This differs from using a HiDPI device because some web pages load different, higher-resolution images when they know they will be displayed on a HiDPI device (but using zoom will not report that there is a HiDPI device).
```{r eval=FALSE}
webshot("https://www.r-project.org/", "r-sidebar-zoom.png",
selector = ".sidebar", zoom = 2)
```
### Vectorization
All parameters of function `webshot`. That means that multiple screenshots can be taken with a single command. When taking a lot of screenshots, vectorization can divide by 5 the execution time.
```{r eval=FALSE}
# Take a screenshot of different sites
webshot(c("https://www.r-project.org/", "https://github.com/wch/webshot"),
file = c("r.png", "webshot.png"))
# Save screenshots of the same site in different formats
webshot("https://www.r-project.org/", file = c("r.png", "r.pdf"))
# Take screenshots of different sections of the same site.
# Note that unlike arguments "url" and "file", a list is required to specify
# multiple selectors. This is also the case for arguments "cliprect" and
# "expand"
webshot("http://rstudio.github.io/leaflet/",
file = c("leaflet_features.png", "leaflet_install.png"),
selector = list("#features", "#installation"))
```
### Screenshots of Shiny applications
The `appshot()` function will run a Shiny app locally in a separate R process, and take a screenshot of it. After taking the screenshot, it will kill the R process that is running the Shiny app.
```{r eval=FALSE}
# Get the directory of one of the Shiny examples
appdir <- system.file("examples", "01_hello", package="shiny")
appshot(appdir, "01_hello.png")
```
### Screenshots of R Markdown documents
The `rmdshot()` function takes screenshots of R Markdown documents. For static R Markdown documents, it renders them to HTML in a temporary directory (using `rmarkdown::render()`)and then takes a screenshot.
For dynamic R Markdown documents, it runs them using `rmarkdown::run()` in a separate R process and then takes a screenshot. After taking the screenshot, it will kill the R process that is running the document.
```{r eval=FALSE}
rmdshot("document.rmd", "document.png")
```
### Manipulating images
If you have GraphicsMagick (recommended) or ImageMagick installed, you can pass the result to `resize()` to resize the image after taking the screenshot. This can take any valid ImageMagick geometry specifictaion, like `"75%"`, or `"400x"` (for an image 400 pixels wide). However, you may get different (and often better) results by using the `zoom` option: the fonts and graphical elements will render more sharply. However, compared to simply resizing, zooming out may result in slightly different positioning of text and layout elements.
You can also call `shrink()`, which runs [OptiPNG](https://optipng.sourceforge.net/) to shrink the PNG file losslessly.
```{r eval=FALSE}
webshot("https://www.r-project.org/", "r-small-resized.png") %>%
resize("75%") %>%
shrink()
# Using zoom instead of resize()
webshot("https://www.r-project.org/", "r-small-zoomed.png", zoom = 0.75) %>%
shrink()
# Can specify pixel dimensions for resize()
webshot("https://www.r-project.org/", "r-small.png") %>%
resize("400x") %>%
shrink()
```
```{r eval=FALSE, echo=FALSE}
# Take the screenshots that are shown below
webshot("https://www.r-project.org/", cliprect = c(0, 0, 992, 500),
"man/figures/r-small-resized.png") %>%
resize("50%") %>%
shrink() %>%
invisible()
# Using zoom instead of resize()
webshot("https://www.r-project.org/", cliprect = c(0, 0, 992, 500),
"man/figures/r-small-zoomed.png", zoom = 0.5) %>%
shrink() %>%
invisible()
```
To illustrate the difference between `resize()` and `zoom`, here is an image with `resize("50%")`:
And here is one with `zoom = 0.5`. If you look closely, you'll see that the text and graphics are sharper. You'll also see that the bullet points and text are positioned slightly differently:
