getWaterfallImage: Get the waterfall PNG image

In johndharrison/webpagetestr: `WebPageTest` API wrapper for R

Description

get the waterfall PNG image

Usage

getWaterfallImage(server, testId, run = 1L, file = NULL,
  repeatView = FALSE, thumbnail = FALSE, chartType = c("waterfall",
  "connection"), colorByMime = FALSE, chartWidth = NULL, maxTime = NULL,
  wrequests = NULL, noCPU = FALSE, noBandwidth = FALSE,
  noEllipsis = FALSE, noLabels = FALSE, dryRun = FALSE, ...)

Arguments

server	A WebPagetest server
testId	test ID string
run	an integer. Which run number on a multiple runs test. Defaults to 1L.
file	Write the result returned to file. Defaults to NULL = don't write to file
repeatView	get the Repeat View (cached view) instead of default First View (primed cache). Defaults to FALSE
thumbnail	logical. Get the thumbnail of actual image. Defaults to FALSE
chartType	Set the chart type: "waterfall" or "connection". Defaults to "waterfall"
colorByMime	logical. set chart coloring by MIME type. Defaults to FALSE.
chartWidth	Integer. Set the chart image width in px (300-2000). Defaults to 930.
maxTime	Set maximum time in seconds. Default is NULL = automatic
wrequests	string. Filter requests (e.g.:1,2,3,4-9,8). Defaults to NULL = all
noCPU	logical. Hide CPU utilization. Defaults to FALSE.
noBandwidth	logical. Hide bandwidth utilization. Defaults to FALSE.
noEllipsis	logical. Hide ellipsis (...) for missing items. Defaults to FALSE.
noLabels	logical. Hide labels for requests (URL). Defaults to FALSE.
dryRun	If TRUE just return the RESTful API URL. Defaults to FALSE
...	Additonal function arguments

Value

If a file argument is given the PNG returned is written to file. Else a raster is returned via readPNG

Examples

## Not run: 
  WPT <- server()
  history <- getHistory(WPT, filter = "London")
  tID <- as.character(history[dim(history)[1], "Test ID"])
  har <- getWaterfallImage(WPT, tID)

## End(Not run)

johndharrison/webpagetestr documentation built on May 19, 2019, 5:14 p.m.