Browse Source

fixed some dox, added generic lua add function to DSL; properly named as_response

boB Rudis 3 years ago
parent
commit
fbc8b84c35

+ 2
- 1
NAMESPACE View File

@@ -7,7 +7,7 @@ export(HARviewer)
7 7
 export(HARviewerOutput)
8 8
 export(as_har)
9 9
 export(as_req)
10
-export(as_request)
10
+export(as_response)
11 11
 export(execute_lua)
12 12
 export(get_body_size)
13 13
 export(get_content_size)
@@ -41,6 +41,7 @@ export(render_json)
41 41
 export(render_png)
42 42
 export(splash)
43 43
 export(splash_active)
44
+export(splash_add_lua)
44 45
 export(splash_click)
45 46
 export(splash_debug)
46 47
 export(splash_focus)

+ 1
- 1
R/as_request.r View File

@@ -18,7 +18,7 @@
18 18
 #'   map(as_request) %>%
19 19
 #'   map(httr::content, as="parsed")
20 20
 #' }
21
-as_request <- function(har_entry) {
21
+as_response <- function(har_entry) {
22 22
 
23 23
   if (length(har_entry$response$content$text) > 0) {
24 24
     content_body <- openssl::base64_decode(har_entry$response$content$text)

+ 5
- 5
R/docker-splash.r View File

@@ -21,8 +21,8 @@ install_splash <- function(host = harbor::localhost) {
21 21
 #' @param host Docker host; defaults to `localhost`
22 22
 #' @param add_tempdir This is `FALSE` initially since you could try to run
23 23
 #'   the splash image on a remote system. It has to be a local one for this to work.
24
-#'   If `TRUE` then a local temporary directory (made with [tempdir]())
25
-#'   will be added to the mount configuration for use with [render_file](). You will need to
24
+#'   If `TRUE` then a local temporary directory (made with [tempdir()])
25
+#'   will be added to the mount configuration for use with [render_file()]. You will need to
26 26
 #'       ensure the necessary system temp dirs are accessible as a mounts. For
27 27
 #'       macOS this means adding `/private` to said Docker config.
28 28
 #' @note you need Docker running on your system and have pulled the container with
@@ -55,10 +55,10 @@ start_splash <- function(host = harbor::localhost, add_tempdir=FALSE) {
55 55
 
56 56
 #' Stop a running a Splash server Docker container
57 57
 #'
58
-#' @param splash_container Docker `container` object created by [start_splash]
58
+#' @param splash_container Docker `container` object created by [start_splash()]
59 59
 #' @note you need Docker running on your system and have pulled the container with
60
-#'       [install_splash] and started the Splash container with [start_splash] for this
61
-#'       to work. You will need the `container` object from [start_splash] for this to work.
60
+#'       [install_splash()] and started the Splash container with [start_splash()] for this
61
+#'       to work. You will need the `container` object from [start_splash()] for this to work.
62 62
 #' @export
63 63
 #' @examples \dontrun{
64 64
 #' install_splash()

+ 32
- 5
R/dsl.r View File

@@ -10,6 +10,33 @@ end
10 10
 
11 11
 }
12 12
 
13
+#' Add raw lua code into DSL call chain
14
+#'
15
+#' The `splashr` `lua` DSL (domain specific language) wrapper wraps what the package
16
+#' author believes to be the most common/useful `lua` functions. Users of the package
17
+#' may have need to insert some custom `lua` code within a DSL call chain they are
18
+#' building. You can insert any Splash `lua` code you like with this function call.
19
+#'
20
+#' The code is inserted at the position the `splash_add_lua`() is called in the chain
21
+#' which will be within the main "splash' function which is defined as:
22
+#'
23
+#' ```
24
+#' function main(splash)
25
+#'   ...
26
+#' end
27
+#' ```
28
+#'
29
+#' If you need more flexibility, use the [execute_lua()] function.
30
+#'
31
+#' @md
32
+#' @param splash_obj splashr object
33
+#' @param lua_code length 1 character vector of raw `lua` code
34
+#' @export
35
+splash_add_lua <- function(splash_obj, lua_code) {
36
+   splash_obj$calls <- c(splash_obj$calls, lua_code, "\n")
37
+   splash_obj
38
+}
39
+
13 40
 #' Enable or disable response content tracking.
14 41
 #'
15 42
 #' By default Splash doesn’t keep bodies of each response in memory, for efficiency reasons.
@@ -125,7 +152,7 @@ splash_focus <- function(splash_obj, selector) {
125 152
 
126 153
 #' Send text as input to page context, literally, character by character.
127 154
 #'
128
-#' This is different from [splash_send_keys]
155
+#' This is different from [splash_send_keys()]
129 156
 #'
130 157
 #' @md
131 158
 #' @note This adds a call to `splash:wait` so you do not have to
@@ -145,7 +172,7 @@ splash_send_text <- function(splash_obj, text) {
145 172
 #' - whitespace is ignored and only used to separate the different keys
146 173
 #' - characters are literally represented
147 174
 #'
148
-#' This is different from [splash_send_text]
175
+#' This is different from [splash_send_text()]
149 176
 #'
150 177
 #' @md
151 178
 #' @param splash_obj splashr object
@@ -204,7 +231,7 @@ splash_wait <- function(splash_obj, time=2) {
204 231
 
205 232
 #' Return information about Splash interaction with a website in HAR format.
206 233
 #'
207
-#' Similar to [render_har] but used in a script context. Should be the LAST element in
234
+#' Similar to [render_har()] but used in a script context. Should be the LAST element in
208 235
 #' a DSL script chain as this will execute the script and return the HAR content
209 236
 #'
210 237
 #' @md
@@ -231,7 +258,7 @@ splash_har <- function(splash_obj) {
231 258
 
232 259
 #' Return a HTML snapshot of a current page.
233 260
 #'
234
-#' Similar to [render_html] but used in a script context. Should be the LAST element in
261
+#' Similar to [render_html()] but used in a script context. Should be the LAST element in
235 262
 #' a DSL script chain as this will execute the script and return the HTML content
236 263
 #'
237 264
 #' @md
@@ -262,7 +289,7 @@ splash_html <- function(splash_obj, raw_html=FALSE) {
262 289
 
263 290
 #' Return a screenshot of a current page in PNG format.
264 291
 #'
265
-#' Similar to [render_png] but used in a script context. Should be the LAST element in
292
+#' Similar to [render_png()] but used in a script context. Should be the LAST element in
266 293
 #' a DSL script chain as this will execute the script and return the PNG content
267 294
 #'
268 295
 #' @md

+ 2
- 2
R/execute.r View File

@@ -1,8 +1,8 @@
1 1
 #' Execute a custom rendering script and return a result.
2 2
 #'
3 3
 #' @md
4
-#' @param splash_obj Object created by a call to [splash]
5
-#' @param lua_source Browser automation script. See [Splash Script](http://splash.readthedocs.io/en/stable/scripting-tutorial.html#scripting-tutorial) Tutorial for more info.
4
+#' @param splash_obj Object created by a call to [splash()]
5
+#' @param lua_sourc Browser automation script. See [Splash Script](http://splash.readthedocs.io/en/stable/scripting-tutorial.html#scripting-tutorial) Tutorial for more info.
6 6
 #' @param timeout A timeout (in seconds) for the render (defaults to 30).
7 7
 #' @param allowed_domains Comma-separated list of allowed domain names. If present, Splash won’t load anything neither from domains not in this list nor from subdomains of domains not in this list.
8 8
 #' @param proxy Proxy profile name or proxy URL.

+ 1
- 1
R/helpers.r View File

@@ -29,7 +29,7 @@ is_content_type <- function(har_resp_obj, type="application/json") {
29 29
 }
30 30
 
31 31
 #' @rdname get_content_type
32
-#' @param har_resp_obj a reponse object from [render_har]() or [execute_lua]()
32
+#' @param har_resp_obj a reponse object from [render_har()] or [execute_lua()]
33 33
 #' @export
34 34
 is_json <- function(har_resp_obj) { is_content_type(har_resp_obj) }
35 35
 

+ 2
- 2
R/render-har.r View File

@@ -6,7 +6,7 @@
6 6
 #' @md
7 7
 #' @param response_body When `TRUE`, response content is included in the HAR records
8 8
 #' @inheritParams render_html
9
-#' @return a `HARtools` `har` object
9
+#' @return a [HARtools] `har` object
10 10
 #' @references [Splash docs](http://splash.readthedocs.io/en/stable/index.html)
11 11
 #' @export
12 12
 render_har <- function(splash_obj = splash_local, url, base_url, response_body=FALSE, timeout=30, resource_timeout, wait=0,
@@ -47,7 +47,7 @@ render_har <- function(splash_obj = splash_local, url, base_url, response_body=F
47 47
 
48 48
 #' Turn a generic Splash HAR response into a HAR object
49 49
 #'
50
-#' @param splash_resp splash response object as returned by `splash::har()` lua script
50
+#' @param splash_resp splash response object
51 51
 #' @export
52 52
 as_har <- function(splash_resp) {
53 53
 

+ 3
- 3
R/render-html.r View File

@@ -3,7 +3,7 @@
3 3
 #' Similar to `rvest::read_html`.
4 4
 #'
5 5
 #' @md
6
-#' @param splash_obj Object created by a call to [splash]
6
+#' @param splash_obj Object created by a call to [splash()]
7 7
 #' @param url The URL to render (required)
8 8
 #' @param base_url The base url to render the page with.
9 9
 #' @param timeout A timeout (in seconds) for the render (defaults to 30).
@@ -24,9 +24,9 @@
24 24
 #' @param save_args A list of argument names to put in cache.
25 25
 #' @param load_args Parameter values to load from cache
26 26
 #' @param raw_html if `TRUE` then return a character vector vs an XML document. Only valid for `render_html`
27
-#' @return An XML document. Note that this is processed by [xml2::read_html] so it will not be
27
+#' @return An XML document. Note that this is processed by [xml2::read_html()] so it will not be
28 28
 #'         the pristine, raw, rendered HTML from the site. Use `raw_html=TRUE` if you do not want it
29
-#'         to be processed first by `xml2`. If you choose `raw_html=TRUE` you'll get back a
29
+#'         to be processed first by [xml2]. If you choose `raw_html=TRUE` you'll get back a
30 30
 #'         character vector.
31 31
 #' @references [Splash docs](http://splash.readthedocs.io/en/stable/index.html)
32 32
 #' @export

+ 2
- 2
R/render-json.r View File

@@ -17,14 +17,14 @@
17 17
 #'                like images and AJAX queries is not returned). To get information about all
18 18
 #'                requests and responses use `har` parameter.
19 19
 #' @param har Whether to include HAR in output. If `TRUE` the result will contain the same
20
-#'            data as [render_har] provides under `har` list entry. By default, response
20
+#'            data as [render_har()] provides under `har` list entry. By default, response
21 21
 #'            content is not included. To enable it use `response_body` parameter.
22 22
 #' @param response_body Used with `har` parameter.
23 23
 #' @return a huge `list`
24 24
 #' @inheritParams render_jpeg
25 25
 #' @note All "whether to include..." parameters are default `TRUE` except for `png` and
26 26
 #'       `jpeg` and a custom `print` method is defined to stop your console from being
27
-#'       overwhelmed with data. Use [str] to inspect various portions of the result.
27
+#'       overwhelmed with data. Use [str()] to inspect various portions of the result.
28 28
 #' @references [Splash docs](http://splash.readthedocs.io/en/stable/index.html)
29 29
 #' @export
30 30
 render_json <- function(splash_obj = splash_local, url, base_url=NULL, quality=75, width=1024, height=768,

+ 2
- 2
R/render_file.R View File

@@ -6,12 +6,12 @@
6 6
 #' TODO Enable passing in of an htmlwidget and use saveWidget
7 7
 #'
8 8
 #' @md
9
-#' @param splash_obj Object created by a call to [splash]()
9
+#' @param splash_obj Object created by a call to [splash()]
10 10
 #' @param file_path Absolute path to a filename on the local host. **This only works with a locally running Splash instance started with [start_splash]().**
11 11
 #' @param wait seconds to wait
12 12
 #' @param output either `html` or `png` to get the page content or an image capture
13 13
 #' @param viewport View width and height (in pixels) of the browser viewport to render the web page. Format is "`<width>x<height>`". e.g. 800x600. Default value is 1024x768.
14
-#' @param ... other params to [render_html]() or [render_png]()
14
+#' @param ... other params to [render_html()] or [render_png()]
15 15
 #' @return An XML document or `magick` object
16 16
 #' @export
17 17
 render_file <- function(splash_obj = splash_local, file_path, output=c("html", "png"), wait=0, viewport="1024x768", ...) {

+ 1
- 1
man/as_har.Rd View File

@@ -7,7 +7,7 @@
7 7
 as_har(splash_resp)
8 8
 }
9 9
 \arguments{
10
-\item{splash_resp}{splash response object as returned by `splash::har()` lua script}
10
+\item{splash_resp}{splash response object}
11 11
 }
12 12
 \description{
13 13
 Turn a generic Splash HAR response into a HAR object

man/as_request.Rd → man/as_response.Rd View File

@@ -1,10 +1,10 @@
1 1
 % Generated by roxygen2: do not edit by hand
2 2
 % Please edit documentation in R/as_request.r
3
-\name{as_request}
4
-\alias{as_request}
3
+\name{as_response}
4
+\alias{as_response}
5 5
 \title{Return a HAR entry response as an httr::response object}
6 6
 \usage{
7
-as_request(har_entry)
7
+as_response(har_entry)
8 8
 }
9 9
 \arguments{
10 10
 \item{har_entry}{a HAR object (should contain a response body to be most useful)}

+ 3
- 3
man/execute_lua.Rd View File

@@ -8,9 +8,7 @@ execute_lua(splash_obj, lua_source, timeout = 30, allowed_domains, proxy,
8 8
   filters, save_args, load_args)
9 9
 }
10 10
 \arguments{
11
-\item{splash_obj}{Object created by a call to \link{splash}}
12
-
13
-\item{lua_source}{Browser automation script. See \href{http://splash.readthedocs.io/en/stable/scripting-tutorial.html#scripting-tutorial}{Splash Script} Tutorial for more info.}
11
+\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
14 12
 
15 13
 \item{timeout}{A timeout (in seconds) for the render (defaults to 30).}
16 14
 
@@ -23,6 +21,8 @@ execute_lua(splash_obj, lua_source, timeout = 30, allowed_domains, proxy,
23 21
 \item{save_args}{A list of argument names to put in cache.}
24 22
 
25 23
 \item{load_args}{Parameter values to load from cache}
24
+
25
+\item{lua_sourc}{Browser automation script. See \href{http://splash.readthedocs.io/en/stable/scripting-tutorial.html#scripting-tutorial}{Splash Script} Tutorial for more info.}
26 26
 }
27 27
 \value{
28 28
 \code{raw} content from the \code{httr} call. Given the vast diversity of possible return values, it's up to the caller to handle the return value.

+ 1
- 1
man/get_content_type.Rd View File

@@ -46,7 +46,7 @@ is_gif(har_resp_obj)
46 46
 is_xhr(har_resp_obj)
47 47
 }
48 48
 \arguments{
49
-\item{har_resp_obj}{a reponse object from [render_har]() or [execute_lua]()}
49
+\item{har_resp_obj}{a reponse object from [render_har()] or [execute_lua()]}
50 50
 
51 51
 \item{type}{content type to compare to (default: "\code{application/json}")}
52 52
 }

+ 2
- 2
man/render_file.Rd View File

@@ -8,7 +8,7 @@ render_file(splash_obj = splash_local, file_path, output = c("html", "png"),
8 8
   wait = 0, viewport = "1024x768", ...)
9 9
 }
10 10
 \arguments{
11
-\item{splash_obj}{Object created by a call to \url{splash}}
11
+\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
12 12
 
13 13
 \item{file_path}{Absolute path to a filename on the local host. \strong{This only works with a locally running Splash instance started with \url{start_splash}.}}
14 14
 
@@ -18,7 +18,7 @@ render_file(splash_obj = splash_local, file_path, output = c("html", "png"),
18 18
 
19 19
 \item{viewport}{View width and height (in pixels) of the browser viewport to render the web page. Format is "\code{<width>x<height>}". e.g. 800x600. Default value is 1024x768.}
20 20
 
21
-\item{...}{other params to \url{render_html} or \url{render_png}}
21
+\item{...}{other params to \code{\link[=render_html]{render_html()}} or \code{\link[=render_png]{render_png()}}}
22 22
 }
23 23
 \value{
24 24
 An XML document or \code{magick} object

+ 2
- 2
man/render_har.Rd View File

@@ -11,7 +11,7 @@ render_har(splash_obj = splash_local, url, base_url, response_body = FALSE,
11 11
   load_args)
12 12
 }
13 13
 \arguments{
14
-\item{splash_obj}{Object created by a call to \link{splash}}
14
+\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
15 15
 
16 16
 \item{url}{The URL to render (required)}
17 17
 
@@ -54,7 +54,7 @@ render_har(splash_obj = splash_local, url, base_url, response_body = FALSE,
54 54
 \item{load_args}{Parameter values to load from cache}
55 55
 }
56 56
 \value{
57
-a \code{HARtools} \code{har} object
57
+a \link{HARtools} \code{har} object
58 58
 }
59 59
 \description{
60 60
 It includes information about requests made, responses received, timings, headers, etc and

+ 3
- 3
man/render_html.Rd View File

@@ -10,7 +10,7 @@ render_html(splash_obj = splash_local, url, base_url, timeout = 30,
10 10
   images, headers, body, http_method, save_args, load_args, raw_html = FALSE)
11 11
 }
12 12
 \arguments{
13
-\item{splash_obj}{Object created by a call to \link{splash}}
13
+\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
14 14
 
15 15
 \item{url}{The URL to render (required)}
16 16
 
@@ -53,9 +53,9 @@ render_html(splash_obj = splash_local, url, base_url, timeout = 30,
53 53
 \item{raw_html}{if \code{TRUE} then return a character vector vs an XML document. Only valid for \code{render_html}}
54 54
 }
55 55
 \value{
56
-An XML document. Note that this is processed by \link[xml2:read_html]{xml2::read_html} so it will not be
56
+An XML document. Note that this is processed by \code{\link[xml2:read_html]{xml2::read_html()}} so it will not be
57 57
 the pristine, raw, rendered HTML from the site. Use \code{raw_html=TRUE} if you do not want it
58
-to be processed first by \code{xml2}. If you choose \code{raw_html=TRUE} you'll get back a
58
+to be processed first by \link{xml2}. If you choose \code{raw_html=TRUE} you'll get back a
59 59
 character vector.
60 60
 }
61 61
 \description{

+ 1
- 1
man/render_jpeg.Rd View File

@@ -11,7 +11,7 @@ render_jpeg(splash_obj = splash_local, url, base_url = NULL, quality = 75,
11 11
   images, headers, body, http_method, save_args, load_args)
12 12
 }
13 13
 \arguments{
14
-\item{splash_obj}{Object created by a call to \link{splash}}
14
+\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
15 15
 
16 16
 \item{url}{The URL to render (required)}
17 17
 

+ 3
- 3
man/render_json.Rd View File

@@ -13,7 +13,7 @@ render_json(splash_obj = splash_local, url, base_url = NULL, quality = 75,
13 13
   console = TRUE, history = TRUE, har = TRUE, response_body = FALSE)
14 14
 }
15 15
 \arguments{
16
-\item{splash_obj}{Object created by a call to \link{splash}}
16
+\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
17 17
 
18 18
 \item{url}{The URL to render (required)}
19 19
 
@@ -81,7 +81,7 @@ like images and AJAX queries is not returned). To get information about all
81 81
 requests and responses use \code{har} parameter.}
82 82
 
83 83
 \item{har}{Whether to include HAR in output. If \code{TRUE} the result will contain the same
84
-data as \link{render_har} provides under \code{har} list entry. By default, response
84
+data as \code{\link[=render_har]{render_har()}} provides under \code{har} list entry. By default, response
85 85
 content is not included. To enable it use \code{response_body} parameter.}
86 86
 
87 87
 \item{response_body}{Used with \code{har} parameter.}
@@ -95,7 +95,7 @@ It can include HTML, PNG and other information, based on arguments passed.
95 95
 \note{
96 96
 All "whether to include..." parameters are default \code{TRUE} except for \code{png} and
97 97
 \code{jpeg} and a custom \code{print} method is defined to stop your console from being
98
-overwhelmed with data. Use \link{str} to inspect various portions of the result.
98
+overwhelmed with data. Use \code{\link[=str]{str()}} to inspect various portions of the result.
99 99
 }
100 100
 \references{
101 101
 \href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}

+ 1
- 1
man/render_png.Rd View File

@@ -11,7 +11,7 @@ render_png(splash_obj = splash_local, url, base_url = NULL, width = 1024,
11 11
   images, headers, body, http_method, save_args, load_args)
12 12
 }
13 13
 \arguments{
14
-\item{splash_obj}{Object created by a call to \link{splash}}
14
+\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
15 15
 
16 16
 \item{url}{The URL to render (required)}
17 17
 

+ 28
- 0
man/splash_add_lua.Rd View File

@@ -0,0 +1,28 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/dsl.r
3
+\name{splash_add_lua}
4
+\alias{splash_add_lua}
5
+\title{Add raw lua code into DSL call chain}
6
+\usage{
7
+splash_add_lua(splash_obj, lua_code)
8
+}
9
+\arguments{
10
+\item{splash_obj}{splashr object}
11
+
12
+\item{lua_code}{length 1 character vector of raw \code{lua} code}
13
+}
14
+\description{
15
+The \code{splashr} \code{lua} DSL (domain specific language) wrapper wraps what the package
16
+author believes to be the most common/useful \code{lua} functions. Users of the package
17
+may have need to insert some custom \code{lua} code within a DSL call chain they are
18
+building. You can insert any Splash \code{lua} code you like with this function call.
19
+}
20
+\details{
21
+The code is inserted at the position the \code{splash_add_lua}() is called in the chain
22
+which will be within the main "splash' function which is defined as:\preformatted{function main(splash)
23
+  ...
24
+end
25
+}
26
+
27
+If you need more flexibility, use the \code{\link[=execute_lua]{execute_lua()}} function.
28
+}

+ 1
- 1
man/splash_har.Rd View File

@@ -10,7 +10,7 @@ splash_har(splash_obj)
10 10
 \item{splash_obj}{splashr object}
11 11
 }
12 12
 \description{
13
-Similar to \link{render_har} but used in a script context. Should be the LAST element in
13
+Similar to \code{\link[=render_har]{render_har()}} but used in a script context. Should be the LAST element in
14 14
 a DSL script chain as this will execute the script and return the HAR content
15 15
 }
16 16
 \examples{

+ 1
- 1
man/splash_html.Rd View File

@@ -12,7 +12,7 @@ splash_html(splash_obj, raw_html = FALSE)
12 12
 \item{raw_html}{if \code{TRUE} then return a character vector vs an XML document.}
13 13
 }
14 14
 \description{
15
-Similar to \link{render_html} but used in a script context. Should be the LAST element in
15
+Similar to \code{\link[=render_html]{render_html()}} but used in a script context. Should be the LAST element in
16 16
 a DSL script chain as this will execute the script and return the HTML content
17 17
 }
18 18
 \examples{

+ 1
- 1
man/splash_png.Rd View File

@@ -13,7 +13,7 @@ splash_png(splash_obj)
13 13
 a \link{magick} image object
14 14
 }
15 15
 \description{
16
-Similar to \link{render_png} but used in a script context. Should be the LAST element in
16
+Similar to \code{\link[=render_png]{render_png()}} but used in a script context. Should be the LAST element in
17 17
 a DSL script chain as this will execute the script and return the PNG content
18 18
 }
19 19
 \examples{

+ 1
- 1
man/splash_send_keys.Rd View File

@@ -18,7 +18,7 @@ splash_send_keys(splash_obj, keys)
18 18
 }
19 19
 }
20 20
 \details{
21
-This is different from \link{splash_send_text}
21
+This is different from \code{\link[=splash_send_text]{splash_send_text()}}
22 22
 }
23 23
 \references{
24 24
 See \href{https://splash.readthedocs.io/en/stable/scripting-ref.html#splash-send-keys}{the docs} for more info

+ 1
- 1
man/splash_send_text.Rd View File

@@ -12,7 +12,7 @@ splash_send_text(splash_obj, text)
12 12
 \item{text}{string to send}
13 13
 }
14 14
 \description{
15
-This is different from \link{splash_send_keys}
15
+This is different from \code{\link[=splash_send_keys]{splash_send_keys()}}
16 16
 }
17 17
 \note{
18 18
 This adds a call to \code{splash:wait} so you do not have to

+ 2
- 2
man/start_splash.Rd View File

@@ -11,8 +11,8 @@ start_splash(host = harbor::localhost, add_tempdir = FALSE)
11 11
 
12 12
 \item{add_tempdir}{This is `FALSE` initially since you could try to run
13 13
 the splash image on a remote system. It has to be a local one for this to work.
14
-If `TRUE` then a local temporary directory (made with [tempdir]())
15
-will be added to the mount configuration for use with [render_file](). You will need to
14
+If `TRUE` then a local temporary directory (made with [tempdir()])
15
+will be added to the mount configuration for use with [render_file()]. You will need to
16 16
     ensure the necessary system temp dirs are accessible as a mounts. For
17 17
     macOS this means adding `/private` to said Docker config.}
18 18
 }

+ 3
- 3
man/stop_splash.Rd View File

@@ -7,15 +7,15 @@
7 7
 stop_splash(splash_container)
8 8
 }
9 9
 \arguments{
10
-\item{splash_container}{Docker `container` object created by [start_splash]}
10
+\item{splash_container}{Docker `container` object created by [start_splash()]}
11 11
 }
12 12
 \description{
13 13
 Stop a running a Splash server Docker container
14 14
 }
15 15
 \note{
16 16
 you need Docker running on your system and have pulled the container with
17
-      [install_splash] and started the Splash container with [start_splash] for this
18
-      to work. You will need the `container` object from [start_splash] for this to work.
17
+      [install_splash()] and started the Splash container with [start_splash()] for this
18
+      to work. You will need the `container` object from [start_splash()] for this to work.
19 19
 }
20 20
 \examples{
21 21
 \dontrun{

Loading…
Cancel
Save