README.md

In yjalbert/profvis: Visualize profiling data

Profvis

Profvis is a tool for visualizing code profiling data from R. It creates a web page which provides a graphical interface for exploring the data. Live demo.

Installation

Profvis is not yet on CRAN; it is currently available from GitHub. Make sure you have the devtools package installed, and then run:

devtools::install_github("rstudio/profvis")

Documentation

See the introduction vignette.

Example

To run code with profiling, wrap the expression in profvis(). By default, this will result in the interactive profile visualizer opening in a web browser. You can see a live demo here.

library(profvis)
library(ggplot2)  # We'll profile a ggplot graphic

profvis({
  g <- ggplot(diamonds, aes(carat, price)) + geom_point(size = 1, alpha = 0.2)
  print(g)
})

The profvis() call returns an htmlwidget, which by default when printed opens a web browser. If you wish to save the object, it won't open the browser at first, but you can view it later by typing the variable name at the console, or calling print() on it.

p <- profvis({
  g <- ggplot(diamonds, aes(carat, price)) + geom_point(size = 1, alpha = 0.2)
  print(g)
})


# View it with:
p
# or print(p)

yjalbert/profvis documentation built on May 4, 2019, 5:30 p.m.