Browse Source

Docs

master
boB Rudis 3 years ago
parent
commit
a7c5406264
No known key found for this signature in database GPG Key ID: 2A514A4997464560
53 changed files with 536 additions and 37 deletions
  1. +2
    -0
      NAMESPACE
  2. +1
    -0
      R/content.r
  3. +3
    -0
      R/docker-splash.r
  4. +68
    -0
      R/dsl.r
  5. +9
    -3
      R/execute.r
  6. +7
    -1
      R/helpers.r
  7. +1
    -0
      R/render-har.r
  8. +15
    -5
      R/render-html.r
  9. +1
    -0
      R/render-jpg.r
  10. +1
    -0
      R/render-json.r
  11. +1
    -0
      R/render-png.r
  12. +1
    -0
      R/render_file.R
  13. +5
    -0
      R/splashr.r
  14. +14
    -3
      man/execute_lua.Rd
  15. +8
    -0
      man/get_content_size.Rd
  16. +8
    -0
      man/get_content_type.Rd
  17. +8
    -0
      man/get_har_entry.Rd
  18. +8
    -0
      man/get_request_type.Rd
  19. +8
    -0
      man/get_request_url.Rd
  20. +8
    -0
      man/get_response_body.Rd
  21. +8
    -0
      man/har_entry_count.Rd
  22. +4
    -0
      man/install_splash.Rd
  23. +6
    -0
      man/render_file.Rd
  24. +20
    -5
      man/render_har.Rd
  25. +20
    -5
      man/render_html.Rd
  26. +20
    -5
      man/render_jpeg.Rd
  27. +20
    -5
      man/render_json.Rd
  28. +20
    -5
      man/render_png.Rd
  29. +6
    -0
      man/splash_active.Rd
  30. +9
    -0
      man/splash_add_lua.Rd
  31. +9
    -0
      man/splash_click.Rd
  32. +6
    -0
      man/splash_debug.Rd
  33. +34
    -0
      man/splash_enable_javascript.Rd
  34. +9
    -0
      man/splash_focus.Rd
  35. +9
    -0
      man/splash_go.Rd
  36. +9
    -0
      man/splash_har.Rd
  37. +9
    -0
      man/splash_har_reset.Rd
  38. +6
    -0
      man/splash_history.Rd
  39. +9
    -0
      man/splash_html.Rd
  40. +6
    -0
      man/splash_images.Rd
  41. +5
    -0
      man/splash_perf_stats.Rd
  42. +6
    -0
      man/splash_plugins.Rd
  43. +9
    -0
      man/splash_png.Rd
  44. +9
    -0
      man/splash_press.Rd
  45. +35
    -0
      man/splash_private_mode.Rd
  46. +9
    -0
      man/splash_release.Rd
  47. +6
    -0
      man/splash_response_body.Rd
  48. +9
    -0
      man/splash_send_keys.Rd
  49. +9
    -0
      man/splash_send_text.Rd
  50. +5
    -0
      man/splash_version.Rd
  51. +10
    -0
      man/splash_wait.Rd
  52. +4
    -0
      man/start_splash.Rd
  53. +4
    -0
      man/stop_splash.Rd

+ 2
- 0
NAMESPACE View File

@@ -47,6 +47,7 @@ export(splash_active)
export(splash_add_lua)
export(splash_click)
export(splash_debug)
export(splash_enable_javascript)
export(splash_focus)
export(splash_go)
export(splash_har)
@@ -59,6 +60,7 @@ export(splash_perf_stats)
export(splash_plugins)
export(splash_png)
export(splash_press)
export(splash_private_mode)
export(splash_release)
export(splash_response_body)
export(splash_send_keys)


+ 1
- 0
R/content.r View File

@@ -1,6 +1,7 @@
#' Retrieve size of content | body | headers
#'
#' @param har_resp_obj HAR response object
#' @family splash_har_helpers
#' @export
get_content_size <- function(har_resp_obj) {
csize <- har_resp_obj$response$content$size


+ 3
- 0
R/docker-splash.r View File

@@ -4,6 +4,7 @@
#' @param host Docker host; defaults to `localhost`
#' @return `harbor` `host` object
#' @export
#' @family splash_docker_helpers
#' @examples \dontrun{
#' install_splash()
#' splash_container <- start_splash()
@@ -28,6 +29,7 @@ install_splash <- function(host = harbor::localhost) {
#' @note you need Docker running on your system and have pulled the container with
#' [install_splash] for this to work. You should save the resultant `host`
#' object for use in [stop_splash].
#' @family splash_docker_helpers
#' @return `harbor` `container` object
#' @export
#' @examples \dontrun{
@@ -59,6 +61,7 @@ start_splash <- function(host = harbor::localhost, add_tempdir=FALSE) {
#' @note you need Docker running on your system and have pulled the container with
#' [install_splash()] and started the Splash container with [start_splash()] for this
#' to work. You will need the `container` object from [start_splash()] for this to work.
#' @family splash_docker_helpers
#' @export
#' @examples \dontrun{
#' install_splash()


+ 68
- 0
R/dsl.r View File

@@ -29,6 +29,7 @@ end
#' If you need more flexibility, use the [execute_lua()] function.
#'
#' @md
#' @family splash_dsl_functions
#' @param splash_obj splashr object
#' @param lua_code length 1 character vector of raw `lua` code
#' @export
@@ -44,6 +45,7 @@ splash_add_lua <- function(splash_obj, lua_code) {
#' @param splash_obj splashr object
#' @param enable logical
#' @export
#' @family splash_dsl_attributes
#' @examples \dontrun{
#' splash_local %>%
#' splash_response_body(TRUE) %>%
@@ -58,12 +60,64 @@ splash_response_body <- function(splash_obj, enable=FALSE) {
splash_obj
}

#' Enable or disable execution of JavaSript code embedded in the page.
#'
#' Private mode is enabled by default unless you pass flag `--disable-private-mode`
#' at Splash (server) startup. Note that if you disable private mode browsing data such
#' as cookies or items kept in local storage may persist between requests.
#'
#' @md
#' @param splash_obj splashr object
#' @param enable logical
#' @family splash_dsl_attributes
#' @export
#' @examples \dontrun{
#' splash_local %>%
#' splash_response_body(TRUE) %>%
#' splash_private_mode(TRUE) %>%
#' splash_user_agent(ua_macos_chrome) %>%
#' splash_go("https://rud.is/b") %>%
#' splash_wait(2) %>%
#' splash_har() -> rud_har
#' }
splash_private_mode <- function(splash_obj, enable=FALSE) {
splash_obj$calls <- c(splash_obj$calls, sprintf('splash.private_mode_enabled = %s',
if (enable) "true" else "false"))
splash_obj
}

#' Enable or disable execution of JavaSript code embedded in the page.
#'
#' JavaScript execution is enabled by default.
#'
#' @md
#' @param splash_obj splashr object
#' @param enable logical
#' @export
#' @family splash_dsl_attributes
#' @examples \dontrun{
#' splash_local %>%
#' splash_response_body(TRUE) %>%
#' splash_private_mode(TRUE) %>%
#' splash_enable_javascript(FALSE) %>%
#' splash_user_agent(ua_macos_chrome) %>%
#' splash_go("https://rud.is/b") %>%
#' splash_wait(2) %>%
#' splash_har() -> rud_har
#' }
splash_enable_javascript <- function(splash_obj, enable=TRUE) {
splash_obj$calls <- c(splash_obj$calls, sprintf('splash.js_enabled = %s',
if (enable) "true" else "false"))
splash_obj
}

#' Enable or disable browser plugins (e.g. Flash).
#'
#' Plugins are disabled by default.
#'
#' @param splash_obj splashr object
#' @param enable logical
#' @family splash_dsl_attributes
#' @export
#' @examples \dontrun{
#' splash_local %>%
@@ -88,6 +142,7 @@ splash_plugins <- function(splash_obj, enable=FALSE) {
#'
#' @param splash_obj splashr object
#' @param enable logical
#' @family splash_dsl_attributes
#' @export
#' @examples \dontrun{
#' splash_local %>%
@@ -110,6 +165,7 @@ splash_images <- function(splash_obj, enable=TRUE) {
#'
#' @param splash_obj splashr object
#' @param url - URL to load;
#' @family splash_dsl_functions
#' @export
#' @examples \dontrun{
#' splash_local %>%
@@ -128,6 +184,7 @@ splash_go <- function(splash_obj, url) {

#' Trigger mouse click event in web page.
#'
#' @family splash_dsl_functions
#' @param splash_obj splashr object
#' @param x,y coordinates (distances from the left or top, relative to the current viewport)
#' @export
@@ -140,6 +197,7 @@ splash_click <- function(splash_obj, x, y) {
#' Focus on a document element provided by a CSS selector
#'
#' @md
#' @family splash_dsl_functions
#' @param splash_obj splashr object
#' @param selector valid CSS selector
#' @references See [the docs](https://splash.readthedocs.io/en/stable/scripting-ref.html#splash-send-text) for more info
@@ -155,6 +213,7 @@ splash_focus <- function(splash_obj, selector) {
#' This is different from [splash_send_keys()]
#'
#' @md
#' @family splash_dsl_functions
#' @note This adds a call to `splash:wait` so you do not have to
#' @param splash_obj splashr object
#' @param text string to send
@@ -175,6 +234,7 @@ splash_send_text <- function(splash_obj, text) {
#' This is different from [splash_send_text()]
#'
#' @md
#' @family splash_dsl_functions
#' @param splash_obj splashr object
#' @param keys string to send
#' @references See [the docs](https://splash.readthedocs.io/en/stable/scripting-ref.html#splash-send-keys) for more info
@@ -188,6 +248,7 @@ splash_send_keys <- function(splash_obj, keys) {

#' Trigger mouse release event in web page.
#'
#' @family splash_dsl_functions
#' @param splash_obj splashr object
#' @param x,y coordinates (distances from the left or top, relative to the current viewport)
#' @export
@@ -199,6 +260,7 @@ splash_release <- function(splash_obj, x, y) {

#' Trigger mouse press event in web page.
#'
#' @family splash_dsl_functions
#' @param splash_obj splashr object
#' @param x,y coordinates (distances from the left or top, relative to the current viewport)
#' @export
@@ -215,6 +277,7 @@ splash_press <- function(splash_obj, x, y) {
#' @md
#' @param splash_obj splashr object
#' @param time number of seconds to wait
#' @family splash_dsl_functions
#' @export
#' @examples \dontrun{
#' splash_local %>%
@@ -233,6 +296,7 @@ splash_wait <- function(splash_obj, time=2) {
#'
#' @md
#' @param splash_obj splashr object
#' @family splash_dsl_functions
#' @export
splash_har_reset <- function(splash_obj) {
splash_obj$calls <- c(splash_obj$calls, 'splash:har_reset()')
@@ -246,6 +310,7 @@ splash_har_reset <- function(splash_obj) {
#'
#' @md
#' @param splash_obj splashr object
#' @family splash_dsl_functions
#' @export
#' @examples \dontrun{
#' splash_local %>%
@@ -274,6 +339,7 @@ splash_har <- function(splash_obj) {
#' @md
#' @param splash_obj splashr object
#' @param raw_html if `TRUE` then return a character vector vs an XML document.
#' @family splash_dsl_functions
#' @export
#' @examples \dontrun{
#' splash_local %>%
@@ -304,6 +370,7 @@ splash_html <- function(splash_obj, raw_html=FALSE) {
#'
#' @md
#' @param splash_obj splashr object
#' @family splash_dsl_functions
#' @return a [magick] image object
#' @export
#' @examples \dontrun{
@@ -332,6 +399,7 @@ splash_png <- function(splash_obj) {
#' @md
#' @param splash_obj splashr object
#' @param user_agent 1 element character vector, defaults to `splashr/#.#.#`.
#' @family splash_dsl_functions_functions
#' @export
#' @examples \dontrun{
#' library(rvest)


+ 9
- 3
R/execute.r View File

@@ -3,13 +3,19 @@
#' @md
#' @param splash_obj Object created by a call to [splash()]
#' @param lua_source Browser automation script. See [Splash Script](http://splash.readthedocs.io/en/stable/scripting-tutorial.html#scripting-tutorial) Tutorial for more info.
#' @param timeout A timeout (in seconds) for the render (defaults to 30).
#' @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.
#' @param timeout A timeout (in seconds) for the render (defaults to 30). Without
#' reconfiguring the startup parameters of the Splash server (not this package)
#' the maximum allowed value for the timeout is 60 seconds.
#' @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.
#' @param proxy Proxy profile name or proxy URL.
#' @param filters Comma-separated list of request filter names.
#' @param save_args A list of argument names to put in cache.
#' @param load_args Parameter values to load from cache
#' @return `raw` content from the `httr` call. Given the vast diversity of possible return values, it's up to the caller to handle the return value.
#' @return `raw` content from the `httr` call. Given the vast diversity of possible return
#' values, it's up to the caller to handle the return value.
#' @family splash_renderers
#' @export
#' @examples \dontrun{
#' splash_local %>%


+ 7
- 1
R/helpers.r View File

@@ -2,6 +2,7 @@
#'
#' @md
#' @param har_resp_obj HAR response object
#' @family splash_har_helpers
#' @return A `raw` vector of the content or `NULL`
#' @export
get_response_body <- function(har_resp_obj) {
@@ -12,6 +13,8 @@ get_response_body <- function(har_resp_obj) {

#' Retrieve or test content type of a HAR request object
#'
#' @param har_resp_obj a reponse object from [render_har()] or [execute_lua()]
#' @family splash_har_helpers
#' @export
get_content_type <- function(har_resp_obj) {
ctype <- har_resp_obj$response$content$mimeType
@@ -29,7 +32,6 @@ is_content_type <- function(har_resp_obj, type="application/json") {
}

#' @rdname get_content_type
#' @param har_resp_obj a reponse object from [render_har()] or [execute_lua()]
#' @export
is_json <- function(har_resp_obj) { is_content_type(har_resp_obj) }

@@ -97,6 +99,7 @@ is_xhr <- function(har_resp_obj) {
#' Retrieve request URL
#'
#' @param har_resp_obj HAR response object
#' @family splash_har_helpers
#' @export
get_request_url <- function(har_resp_obj) {
utype <- har_resp_obj$request$url
@@ -107,6 +110,7 @@ get_request_url <- function(har_resp_obj) {
#' Retrieve or test request type
#'
#' @param har_resp_obj HAR response object
#' @family splash_har_helpers
#' @export
get_request_type <- function(har_resp_obj) {
rtype <- har_resp_obj$request$method
@@ -142,6 +146,7 @@ har_entries <- function(x) {
#'
#' @param x can be a `har` object, `harlog` object or `harentries` object
#' @param i index of the HAR entry to retrieve
#' @family splash_har_helpers
#' @export
get_har_entry <- function(x, i=1) {
if (inherits(x, "har")) {
@@ -158,6 +163,7 @@ get_har_entry <- function(x, i=1) {
#' Retrieves number of HAR entries in a response
#'
#' @param x can be a `har` object, `harlog` object or `harentries` object
#' @family splash_har_helpers
#' @export
har_entry_count <- function(x) {
if (inherits(x, "har")) {


+ 1
- 0
R/render-har.r View File

@@ -6,6 +6,7 @@
#' @md
#' @param response_body When `TRUE`, response content is included in the HAR records
#' @inheritParams render_html
#' @family splash_renderers
#' @return a [HARtools] `har` object
#' @references [Splash docs](http://splash.readthedocs.io/en/stable/index.html)
#' @export


+ 15
- 5
R/render-html.r View File

@@ -6,17 +6,26 @@
#' @param splash_obj Object created by a call to [splash()]
#' @param url The URL to render (required)
#' @param base_url The base url to render the page with.
#' @param timeout A timeout (in seconds) for the render (defaults to 30).
#' @param timeout A timeout (in seconds) for the render (defaults to 30). Without
#' reconfiguring the startup parameters of the Splash server (not this package)
#' the maximum allowed value for the timeout is 60 seconds.
#' @param resource_timeout A timeout (in seconds) for individual network requests.
#' @param wait Time (in seconds) to wait for updates after page is loaded (defaults to 0).
#' @param proxy Proxy profile name or proxy URL.
#' @param js Javascript profile name.
#' @param js_src JavaScript code to be executed in page context.
#' @param filters Comma-separated list of request filter names.
#' @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.
#' @param allowed_content_types Comma-separated list of allowed content types. If present, Splash will abort any request if the response’s content type doesn’t match any of the content types in this list. Wildcards are supported.
#' @param forbidden_content_types Comma-separated list of forbidden content types. If present, Splash will abort any request if the response’s content type matches any of the content types in this list. Wildcards are supported.
#' @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 "full".
#' @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.
#' @param allowed_content_types Comma-separated list of allowed content types. If present,
#' Splash will abort any request if the response’s content type doesn’t match any of
#' the content types in this list. Wildcards are supported.
#' @param forbidden_content_types Comma-separated list of forbidden content types. If
#' present, Splash will abort any request if the response’s content type matches
#' any of the content types in this list. Wildcards are supported.
#' @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 "full".
#' @param images Whether to download images.
#' @param headers HTTP headers to set for the first outgoing request.
#' @param body Body of HTTP POST request to be sent if method is POST.
@@ -24,6 +33,7 @@
#' @param save_args A list of argument names to put in cache.
#' @param load_args Parameter values to load from cache
#' @param raw_html if `TRUE` then return a character vector vs an XML document. Only valid for `render_html`
#' @family splash_renderers
#' @return An XML document. Note that this is processed by [xml2::read_html()] so it will not be
#' the pristine, raw, rendered HTML from the site. Use `raw_html=TRUE` if you do not want it
#' to be processed first by `xml2`. If you choose `raw_html=TRUE` you'll get back a


+ 1
- 0
R/render-jpg.r View File

@@ -4,6 +4,7 @@
#' @param quality JPEG quality parameter in range from 0 to 100. Default is quality=75.
#' @inheritParams render_html
#' @inheritParams render_png
#' @family splash_renderers
#' @return a [magick] image object
#' @references [Splash docs](http://splash.readthedocs.io/en/stable/index.html)
#' @export


+ 1
- 0
R/render-json.r View File

@@ -21,6 +21,7 @@
#' content is not included. To enable it use `response_body` parameter.
#' @param response_body Used with `har` parameter.
#' @return a huge `list`
#' @family splash_renderers
#' @inheritParams render_jpeg
#' @note All "whether to include..." parameters are default `TRUE` except for `png` and
#' `jpeg` and a custom `print` method is defined to stop your console from being


+ 1
- 0
R/render-png.r View File

@@ -3,6 +3,7 @@
#' @md
#' @param width,height Resize the rendered image to the given width/height (in pixels) keeping the aspect ratio. These are optional
#' @param render_all If `TRUE` extend the viewport to include the whole webpage (possibly very tall) before rendering.
#' @family splash_renderers
#' @return a [magick] image object
#' @references [Splash docs](http://splash.readthedocs.io/en/stable/index.html)
#' @inheritParams render_html


+ 1
- 0
R/render_file.R View File

@@ -12,6 +12,7 @@
#' @param output either `html` or `png` to get the page content or an image capture
#' @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.
#' @param ... other params to [render_html()] or [render_png()]
#' @family splash_renderers
#' @return An XML document or `magick` object
#' @export
render_file <- function(splash_obj = splash_local, file_path, output=c("html", "png"), wait=0, viewport="1024x768", ...) {


+ 5
- 0
R/splashr.r View File

@@ -19,6 +19,7 @@ s_GET <- purrr::safely(GET)
#'
#' @md
#' @param splash_obj A splash connection object
#' @family splash_info_functions
#' @return `TRUE` if Slash server is running, otherwise `FALSE`
#' @export
splash_active <- function(splash_obj = splash_local) {
@@ -45,6 +46,7 @@ splash_active <- function(splash_obj = splash_local) {
#' Get Splash version information
#'
#' @param splash_obj A splash connection object
#' @family splash_info_functions
#' @export
splash_version <- function(splash_obj = splash_local) {
execute_lua(splash_obj, '
@@ -58,6 +60,7 @@ end
#' Get information about requests/responses for the pages loaded
#'
#' @param splash_obj A splash connection object
#' @family splash_info_functions
#' @export
splash_history <- function(splash_obj = splash_local) {
execute_lua(splash_obj, '
@@ -72,6 +75,7 @@ end
#' Get Splash performance-related statistics
#'
#' @param splash_obj A splash connection object
#' @family splash_info_functions
#' @export
splash_perf_stats <- function(splash_obj = splash_local) {
execute_lua(splash_obj, '
@@ -85,6 +89,7 @@ end
#' Retrieve debug-level info for a Splash server
#'
#' @param splash_obj A splash connection object
#' @family splash_info_functions
#' @export
splash_debug <- function(splash_obj = splash_local) {



+ 14
- 3
man/execute_lua.Rd View File

@@ -12,9 +12,13 @@ execute_lua(splash_obj, lua_source, timeout = 30, allowed_domains, proxy,

\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.}

\item{timeout}{A timeout (in seconds) for the render (defaults to 30).}
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}

\item{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.}
\item{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.}

\item{proxy}{Proxy profile name or proxy URL.}

@@ -25,7 +29,8 @@ execute_lua(splash_obj, lua_source, timeout = 30, allowed_domains, proxy,
\item{load_args}{Parameter values to load from cache}
}
\value{
\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.
\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.
}
\description{
Execute a custom rendering script and return a result.
@@ -48,3 +53,9 @@ rawToChar(res) \%>\%
member_scores
}
}
\seealso{
Other splash_renderers: \code{\link{render_file}},
\code{\link{render_har}}, \code{\link{render_html}},
\code{\link{render_jpeg}}, \code{\link{render_json}},
\code{\link{render_png}}
}

+ 8
- 0
man/get_content_size.Rd View File

@@ -18,3 +18,11 @@ get_headers_size(har_resp_obj)
\description{
Retrieve size of content | body | headers
}
\seealso{
Other splash_har_helpers: \code{\link{get_content_type}},
\code{\link{get_har_entry}},
\code{\link{get_request_type}},
\code{\link{get_request_url}},
\code{\link{get_response_body}},
\code{\link{har_entry_count}}
}

+ 8
- 0
man/get_content_type.Rd View File

@@ -53,3 +53,11 @@ is_xhr(har_resp_obj)
\description{
Retrieve or test content type of a HAR request object
}
\seealso{
Other splash_har_helpers: \code{\link{get_content_size}},
\code{\link{get_har_entry}},
\code{\link{get_request_type}},
\code{\link{get_request_url}},
\code{\link{get_response_body}},
\code{\link{har_entry_count}}
}

+ 8
- 0
man/get_har_entry.Rd View File

@@ -14,3 +14,11 @@ get_har_entry(x, i = 1)
\description{
Retrieve an entry by index from a HAR object
}
\seealso{
Other splash_har_helpers: \code{\link{get_content_size}},
\code{\link{get_content_type}},
\code{\link{get_request_type}},
\code{\link{get_request_url}},
\code{\link{get_response_body}},
\code{\link{har_entry_count}}
}

+ 8
- 0
man/get_request_type.Rd View File

@@ -18,3 +18,11 @@ is_post(har_resp_obj)
\description{
Retrieve or test request type
}
\seealso{
Other splash_har_helpers: \code{\link{get_content_size}},
\code{\link{get_content_type}},
\code{\link{get_har_entry}},
\code{\link{get_request_url}},
\code{\link{get_response_body}},
\code{\link{har_entry_count}}
}

+ 8
- 0
man/get_request_url.Rd View File

@@ -12,3 +12,11 @@ get_request_url(har_resp_obj)
\description{
Retrieve request URL
}
\seealso{
Other splash_har_helpers: \code{\link{get_content_size}},
\code{\link{get_content_type}},
\code{\link{get_har_entry}},
\code{\link{get_request_type}},
\code{\link{get_response_body}},
\code{\link{har_entry_count}}
}

+ 8
- 0
man/get_response_body.Rd View File

@@ -15,3 +15,11 @@ A \code{raw} vector of the content or \code{NULL}
\description{
Retrieve the body content of a HAR entry
}
\seealso{
Other splash_har_helpers: \code{\link{get_content_size}},
\code{\link{get_content_type}},
\code{\link{get_har_entry}},
\code{\link{get_request_type}},
\code{\link{get_request_url}},
\code{\link{har_entry_count}}
}

+ 8
- 0
man/har_entry_count.Rd View File

@@ -12,3 +12,11 @@ har_entry_count(x)
\description{
Retrieves number of HAR entries in a response
}
\seealso{
Other splash_har_helpers: \code{\link{get_content_size}},
\code{\link{get_content_type}},
\code{\link{get_har_entry}},
\code{\link{get_request_type}},
\code{\link{get_request_url}},
\code{\link{get_response_body}}
}

+ 4
- 0
man/install_splash.Rd View File

@@ -22,3 +22,7 @@ splash_container <- start_splash()
stop_splash(splash_container)
}
}
\seealso{
Other splash_docker_helpers: \code{\link{start_splash}},
\code{\link{stop_splash}}
}

+ 6
- 0
man/render_file.Rd View File

@@ -30,3 +30,9 @@ The suggested use-case for this is rendering a widget
TODO Test if container is running
TODO Enable passing in of an htmlwidget and use saveWidget
}
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_har}}, \code{\link{render_html}},
\code{\link{render_jpeg}}, \code{\link{render_json}},
\code{\link{render_png}}
}

+ 20
- 5
man/render_har.Rd View File

@@ -19,7 +19,9 @@ render_har(splash_obj = splash_local, url, base_url, response_body = FALSE,

\item{response_body}{When \code{TRUE}, response content is included in the HAR records}

\item{timeout}{A timeout (in seconds) for the render (defaults to 30).}
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}

\item{resource_timeout}{A timeout (in seconds) for individual network requests.}

@@ -33,13 +35,20 @@ render_har(splash_obj = splash_local, url, base_url, response_body = FALSE,

\item{filters}{Comma-separated list of request filter names.}

\item{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.}
\item{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.}

\item{allowed_content_types}{Comma-separated list of allowed content types. If present, Splash will abort any request if the response’s content type doesn’t match any of the content types in this list. Wildcards are supported.}
\item{allowed_content_types}{Comma-separated list of allowed content types. If present,
Splash will abort any request if the response’s content type doesn’t match any of
the content types in this list. Wildcards are supported.}

\item{forbidden_content_types}{Comma-separated list of forbidden content types. If present, Splash will abort any request if the response’s content type matches any of the content types in this list. Wildcards are supported.}
\item{forbidden_content_types}{Comma-separated list of forbidden content types. If
present, Splash will abort any request if the response’s content type matches
any of the content types in this list. Wildcards are supported.}

\item{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 "full".}
\item{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 "full".}

\item{images}{Whether to download images.}

@@ -63,3 +72,9 @@ is incredibly detailed, full of information on every component loaded.
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_file}}, \code{\link{render_html}},
\code{\link{render_jpeg}}, \code{\link{render_json}},
\code{\link{render_png}}
}

+ 20
- 5
man/render_html.Rd View File

@@ -16,7 +16,9 @@ render_html(splash_obj = splash_local, url, base_url, timeout = 30,

\item{base_url}{The base url to render the page with.}

\item{timeout}{A timeout (in seconds) for the render (defaults to 30).}
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}

\item{resource_timeout}{A timeout (in seconds) for individual network requests.}

@@ -30,13 +32,20 @@ render_html(splash_obj = splash_local, url, base_url, timeout = 30,

\item{filters}{Comma-separated list of request filter names.}

\item{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.}
\item{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.}

\item{allowed_content_types}{Comma-separated list of allowed content types. If present, Splash will abort any request if the response’s content type doesn’t match any of the content types in this list. Wildcards are supported.}
\item{allowed_content_types}{Comma-separated list of allowed content types. If present,
Splash will abort any request if the response’s content type doesn’t match any of
the content types in this list. Wildcards are supported.}

\item{forbidden_content_types}{Comma-separated list of forbidden content types. If present, Splash will abort any request if the response’s content type matches any of the content types in this list. Wildcards are supported.}
\item{forbidden_content_types}{Comma-separated list of forbidden content types. If
present, Splash will abort any request if the response’s content type matches
any of the content types in this list. Wildcards are supported.}

\item{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 "full".}
\item{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 "full".}

\item{images}{Whether to download images.}

@@ -64,3 +73,9 @@ Similar to \code{rvest::read_html}.
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_file}}, \code{\link{render_har}},
\code{\link{render_jpeg}}, \code{\link{render_json}},
\code{\link{render_png}}
}

+ 20
- 5
man/render_jpeg.Rd View File

@@ -23,7 +23,9 @@ render_jpeg(splash_obj = splash_local, url, base_url = NULL, quality = 75,

\item{height}{Resize the rendered image to the given width/height (in pixels) keeping the aspect ratio. These are optional}

\item{timeout}{A timeout (in seconds) for the render (defaults to 30).}
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}

\item{resource_timeout}{A timeout (in seconds) for individual network requests.}

@@ -39,13 +41,20 @@ render_jpeg(splash_obj = splash_local, url, base_url = NULL, quality = 75,

\item{filters}{Comma-separated list of request filter names.}

\item{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.}
\item{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.}

\item{allowed_content_types}{Comma-separated list of allowed content types. If present, Splash will abort any request if the response’s content type doesn’t match any of the content types in this list. Wildcards are supported.}
\item{allowed_content_types}{Comma-separated list of allowed content types. If present,
Splash will abort any request if the response’s content type doesn’t match any of
the content types in this list. Wildcards are supported.}

\item{forbidden_content_types}{Comma-separated list of forbidden content types. If present, Splash will abort any request if the response’s content type matches any of the content types in this list. Wildcards are supported.}
\item{forbidden_content_types}{Comma-separated list of forbidden content types. If
present, Splash will abort any request if the response’s content type matches
any of the content types in this list. Wildcards are supported.}

\item{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 "full".}
\item{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 "full".}

\item{images}{Whether to download images.}

@@ -68,3 +77,9 @@ Return a image (in JPEG format) of the javascript-rendered page.
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_file}}, \code{\link{render_har}},
\code{\link{render_html}}, \code{\link{render_json}},
\code{\link{render_png}}
}

+ 20
- 5
man/render_json.Rd View File

@@ -25,7 +25,9 @@ render_json(splash_obj = splash_local, url, base_url = NULL, quality = 75,

\item{height}{Resize the rendered image to the given width/height (in pixels) keeping the aspect ratio. These are optional}

\item{timeout}{A timeout (in seconds) for the render (defaults to 30).}
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}

\item{resource_timeout}{A timeout (in seconds) for individual network requests.}

@@ -41,13 +43,20 @@ render_json(splash_obj = splash_local, url, base_url = NULL, quality = 75,

\item{filters}{Comma-separated list of request filter names.}

\item{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.}
\item{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.}

\item{allowed_content_types}{Comma-separated list of allowed content types. If present, Splash will abort any request if the response’s content type doesn’t match any of the content types in this list. Wildcards are supported.}
\item{allowed_content_types}{Comma-separated list of allowed content types. If present,
Splash will abort any request if the response’s content type doesn’t match any of
the content types in this list. Wildcards are supported.}

\item{forbidden_content_types}{Comma-separated list of forbidden content types. If present, Splash will abort any request if the response’s content type matches any of the content types in this list. Wildcards are supported.}
\item{forbidden_content_types}{Comma-separated list of forbidden content types. If
present, Splash will abort any request if the response’s content type matches
any of the content types in this list. Wildcards are supported.}

\item{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 "full".}
\item{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 "full".}

\item{images}{Whether to download images.}

@@ -100,3 +109,9 @@ overwhelmed with data. Use \code{\link[=str]{str()}} to inspect various portions
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_file}}, \code{\link{render_har}},
\code{\link{render_html}}, \code{\link{render_jpeg}},
\code{\link{render_png}}
}

+ 20
- 5
man/render_png.Rd View File

@@ -19,7 +19,9 @@ render_png(splash_obj = splash_local, url, base_url = NULL, width, height,

\item{width, height}{Resize the rendered image to the given width/height (in pixels) keeping the aspect ratio. These are optional}

\item{timeout}{A timeout (in seconds) for the render (defaults to 30).}
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}

\item{resource_timeout}{A timeout (in seconds) for individual network requests.}

@@ -35,13 +37,20 @@ render_png(splash_obj = splash_local, url, base_url = NULL, width, height,

\item{filters}{Comma-separated list of request filter names.}

\item{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.}
\item{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.}

\item{allowed_content_types}{Comma-separated list of allowed content types. If present, Splash will abort any request if the response’s content type doesn’t match any of the content types in this list. Wildcards are supported.}
\item{allowed_content_types}{Comma-separated list of allowed content types. If present,
Splash will abort any request if the response’s content type doesn’t match any of
the content types in this list. Wildcards are supported.}

\item{forbidden_content_types}{Comma-separated list of forbidden content types. If present, Splash will abort any request if the response’s content type matches any of the content types in this list. Wildcards are supported.}
\item{forbidden_content_types}{Comma-separated list of forbidden content types. If
present, Splash will abort any request if the response’s content type matches
any of the content types in this list. Wildcards are supported.}

\item{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 "full".}
\item{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 "full".}

\item{images}{Whether to download images.}

@@ -64,3 +73,9 @@ Return a image (in PNG format) of the javascript-rendered page.
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_file}}, \code{\link{render_har}},
\code{\link{render_html}}, \code{\link{render_jpeg}},
\code{\link{render_json}}
}

+ 6
- 0
man/splash_active.Rd View File

@@ -15,3 +15,9 @@ splash_active(splash_obj = splash_local)
\description{
Test if a Splash server is up
}
\seealso{
Other splash_info_functions: \code{\link{splash_debug}},
\code{\link{splash_history}},
\code{\link{splash_perf_stats}},
\code{\link{splash_version}}
}

+ 9
- 0
man/splash_add_lua.Rd View File

@@ -26,3 +26,12 @@ end

If you need more flexibility, use the \code{\link[=execute_lua]{execute_lua()}} function.
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_click}},
\code{\link{splash_focus}}, \code{\link{splash_go}},
\code{\link{splash_har_reset}}, \code{\link{splash_har}},
\code{\link{splash_html}}, \code{\link{splash_png}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 9
- 0
man/splash_click.Rd View File

@@ -14,3 +14,12 @@ splash_click(splash_obj, x, y)
\description{
Trigger mouse click event in web page.
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_focus}}, \code{\link{splash_go}},
\code{\link{splash_har_reset}}, \code{\link{splash_har}},
\code{\link{splash_html}}, \code{\link{splash_png}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 6
- 0
man/splash_debug.Rd View File

@@ -15,4 +15,10 @@ splash_debug(splash_obj = splash_local)
\description{
Retrieve debug-level info for a Splash server
}
\seealso{
Other splash_info_functions: \code{\link{splash_active}},
\code{\link{splash_history}},
\code{\link{splash_perf_stats}},
\code{\link{splash_version}}
}
\keyword{internal}

+ 34
- 0
man/splash_enable_javascript.Rd View File

@@ -0,0 +1,34 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dsl.r
\name{splash_enable_javascript}
\alias{splash_enable_javascript}
\title{Enable or disable execution of JavaSript code embedded in the page.}
\usage{
splash_enable_javascript(splash_obj, enable = TRUE)
}
\arguments{
\item{splash_obj}{splashr object}

\item{enable}{logical}
}
\description{
JavaScript execution is enabled by default.
}
\examples{
\dontrun{
splash_local \%>\%
splash_response_body(TRUE) \%>\%
splash_private_mode(TRUE) \%>\%
splash_enable_javascript(FALSE) \%>\%
splash_user_agent(ua_macos_chrome) \%>\%
splash_go("https://rud.is/b") \%>\%
splash_wait(2) \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_attributes: \code{\link{splash_images}},
\code{\link{splash_plugins}},
\code{\link{splash_private_mode}},
\code{\link{splash_response_body}}
}

+ 9
- 0
man/splash_focus.Rd View File

@@ -17,3 +17,12 @@ Focus on a document element provided by a CSS selector
\references{
See \href{https://splash.readthedocs.io/en/stable/scripting-ref.html#splash-send-text}{the docs} for more info
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_go}},
\code{\link{splash_har_reset}}, \code{\link{splash_har}},
\code{\link{splash_html}}, \code{\link{splash_png}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 9
- 0
man/splash_go.Rd View File

@@ -25,3 +25,12 @@ splash_local \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_har_reset}}, \code{\link{splash_har}},
\code{\link{splash_html}}, \code{\link{splash_png}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 9
- 0
man/splash_har.Rd View File

@@ -23,3 +23,12 @@ splash_local \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_html}}, \code{\link{splash_png}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 9
- 0
man/splash_har_reset.Rd View File

@@ -12,3 +12,12 @@ splash_har_reset(splash_obj)
\description{
Drops all internally stored HAR records.
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har}},
\code{\link{splash_html}}, \code{\link{splash_png}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 6
- 0
man/splash_history.Rd View File

@@ -12,3 +12,9 @@ splash_history(splash_obj = splash_local)
\description{
Get information about requests/responses for the pages loaded
}
\seealso{
Other splash_info_functions: \code{\link{splash_active}},
\code{\link{splash_debug}},
\code{\link{splash_perf_stats}},
\code{\link{splash_version}}
}

+ 9
- 0
man/splash_html.Rd View File

@@ -25,3 +25,12 @@ splash_local \%>\%
splash_html() -> rud_pg
}
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_har}}, \code{\link{splash_png}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 6
- 0
man/splash_images.Rd View File

@@ -27,3 +27,9 @@ splash_local \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_attributes: \code{\link{splash_enable_javascript}},
\code{\link{splash_plugins}},
\code{\link{splash_private_mode}},
\code{\link{splash_response_body}}
}

+ 5
- 0
man/splash_perf_stats.Rd View File

@@ -12,3 +12,8 @@ splash_perf_stats(splash_obj = splash_local)
\description{
Get Splash performance-related statistics
}
\seealso{
Other splash_info_functions: \code{\link{splash_active}},
\code{\link{splash_debug}}, \code{\link{splash_history}},
\code{\link{splash_version}}
}

+ 6
- 0
man/splash_plugins.Rd View File

@@ -24,3 +24,9 @@ splash_local \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_attributes: \code{\link{splash_enable_javascript}},
\code{\link{splash_images}},
\code{\link{splash_private_mode}},
\code{\link{splash_response_body}}
}

+ 9
- 0
man/splash_png.Rd View File

@@ -25,3 +25,12 @@ splash_local \%>\%
splash_png()
}
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_har}}, \code{\link{splash_html}},
\code{\link{splash_press}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 9
- 0
man/splash_press.Rd View File

@@ -14,3 +14,12 @@ splash_press(splash_obj, x, y)
\description{
Trigger mouse press event in web page.
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_har}}, \code{\link{splash_html}},
\code{\link{splash_png}}, \code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 35
- 0
man/splash_private_mode.Rd View File

@@ -0,0 +1,35 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dsl.r
\name{splash_private_mode}
\alias{splash_private_mode}
\title{Enable or disable execution of JavaSript code embedded in the page.}
\usage{
splash_private_mode(splash_obj, enable = FALSE)
}
\arguments{
\item{splash_obj}{splashr object}

\item{enable}{logical}
}
\description{
Private mode is enabled by default unless you pass flag \code{--disable-private-mode}
at Splash (server) startup. Note that if you disable private mode browsing data such
as cookies or items kept in local storage may persist between requests.
}
\examples{
\dontrun{
splash_local \%>\%
splash_response_body(TRUE) \%>\%
splash_private_mode(TRUE) \%>\%
splash_user_agent(ua_macos_chrome) \%>\%
splash_go("https://rud.is/b") \%>\%
splash_wait(2) \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_attributes: \code{\link{splash_enable_javascript}},
\code{\link{splash_images}},
\code{\link{splash_plugins}},
\code{\link{splash_response_body}}
}

+ 9
- 0
man/splash_release.Rd View File

@@ -14,3 +14,12 @@ splash_release(splash_obj, x, y)
\description{
Trigger mouse release event in web page.
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_har}}, \code{\link{splash_html}},
\code{\link{splash_png}}, \code{\link{splash_press}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 6
- 0
man/splash_response_body.Rd View File

@@ -24,3 +24,9 @@ splash_local \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_attributes: \code{\link{splash_enable_javascript}},
\code{\link{splash_images}},
\code{\link{splash_plugins}},
\code{\link{splash_private_mode}}
}

+ 9
- 0
man/splash_send_keys.Rd View File

@@ -23,3 +23,12 @@ This is different from \code{\link[=splash_send_text]{splash_send_text()}}
\references{
See \href{https://splash.readthedocs.io/en/stable/scripting-ref.html#splash-send-keys}{the docs} for more info
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_har}}, \code{\link{splash_html}},
\code{\link{splash_png}}, \code{\link{splash_press}},
\code{\link{splash_release}},
\code{\link{splash_send_text}}, \code{\link{splash_wait}}
}

+ 9
- 0
man/splash_send_text.Rd View File

@@ -20,3 +20,12 @@ This adds a call to \code{splash:wait} so you do not have to
\references{
See \href{https://splash.readthedocs.io/en/stable/scripting-ref.html#splash-send-keys}{the docs} for more info
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_har}}, \code{\link{splash_html}},
\code{\link{splash_png}}, \code{\link{splash_press}},
\code{\link{splash_release}},
\code{\link{splash_send_keys}}, \code{\link{splash_wait}}
}

+ 5
- 0
man/splash_version.Rd View File

@@ -12,3 +12,8 @@ splash_version(splash_obj = splash_local)
\description{
Get Splash version information
}
\seealso{
Other splash_info_functions: \code{\link{splash_active}},
\code{\link{splash_debug}}, \code{\link{splash_history}},
\code{\link{splash_perf_stats}}
}

+ 10
- 0
man/splash_wait.Rd View File

@@ -24,3 +24,13 @@ splash_local \%>\%
splash_har() -> rud_har
}
}
\seealso{
Other splash_dsl_functions: \code{\link{splash_add_lua}},
\code{\link{splash_click}}, \code{\link{splash_focus}},
\code{\link{splash_go}}, \code{\link{splash_har_reset}},
\code{\link{splash_har}}, \code{\link{splash_html}},
\code{\link{splash_png}}, \code{\link{splash_press}},
\code{\link{splash_release}},
\code{\link{splash_send_keys}},
\code{\link{splash_send_text}}
}

+ 4
- 0
man/start_splash.Rd View File

@@ -35,3 +35,7 @@ splash_container <- start_splash()
stop_splash(splash_container)
}
}
\seealso{
Other splash_docker_helpers: \code{\link{install_splash}},
\code{\link{stop_splash}}
}

+ 4
- 0
man/stop_splash.Rd View File

@@ -24,3 +24,7 @@ splash_container <- start_splash()
stop_splash(splash_container)
}
}
\seealso{
Other splash_docker_helpers: \code{\link{install_splash}},
\code{\link{start_splash}}
}

Loading…
Cancel
Save