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.

45 lines
1.5 KiB

7 years ago
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/chrome-shot.r
7 years ago
\name{chrome_shot}
\alias{chrome_shot}
\title{Capture a screenshot}
\usage{
chrome_shot(url, width = NULL, height = NULL, path = NULL,
overwrite = TRUE, chrome_bin = Sys.getenv("HEADLESS_CHROME"))
7 years ago
}
\arguments{
\item{url}{URL to read from}
\item{width, height}{screen size to emulate}
7 years ago
\item{path}{path (with optional output filename) for the generated PDF. If \code{NULL} then
and \code{overwrite} is \code{FALSE}, the fuction will will ensure a uniquely-named file is
placed in the current working directory by incrementing trailing numbers before
the end of it.}
\item{overwrite}{overwrite existing file? Default: \code{TRUE}}
7 years ago
\item{chrome_bin}{the path to Chrome (auto-set from \code{HEADLESS_CHROME} environment variable)}
\item{prime}{if \code{TRUE} preliminary URL retrieval requests will be sent to "prime" the
headless Chrome cache. This seems to be necessary primarily on recent versions of macOS.
If numeric, that number of "prime" requests will be sent ahead of the capture request.
If \code{FALSE} no priming requests will be sent.}
7 years ago
}
\value{
\code{magick}
}
\description{
For the moment, the capture file is in the current working directory and named
\code{screenshot.png}. This will change, soon.
}
\details{
A \code{magick} image object is returned.
}
\note{
The default Chrome filename is \code{screenshot.png}
7 years ago
}
\examples{
chrome_shot("https://www.r-project.org/logo/Rlogo.svg")
}