Tools to Work with the 'Splash' JavaScript Rendering Service in R
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

49 lines
1.4 KiB

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/docker-splash.r
\title{Start a Splash server Docker container}
start_splash(tag = "latest", container_name = "splashr",
remove = FALSE, ...)
\item{tag}{Splash Docker image tag to start}
\item{container_name}{naem for the container. Defaults to "`splashr`".}
\item{remove}{remove the Splash container instance after it's stopped?
Defaults to `FALSE`.}
\item{...}{passed on to Splash instance launch parameters}
`stevedor` container object
If using this in an automation context, you should consider adding a
`Sys.sleep(3)` (or higher) after starting the docker container.
This uses the `latest` image and passed the `--disable-browser-caches`
parameter. If you do not want to use the 3.2.x+ versions of `Splash`
you should use your own startup scripts vs this helper function.
you need Docker running on your system and have pulled the container with
[install_splash] for this to work. You should save the resultant
object for use in [stop_splash] otherwise you'll have to kill it from the
command line interface.
splash_container <- start_splash()
Other splash_docker_helpers: \code{\link{install_splash}},