Skip to content

Commit bfafb5e

Browse files
committed
fix broken link raster2uri and improve the description
1 parent 2bbb5dc commit bfafb5e

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

R/helpers.R

+6-3
Original file line numberDiff line numberDiff line change
@@ -185,15 +185,18 @@ plotly_empty <- function(...) {
185185
}
186186

187187

188-
#' Convert a raster object to a data URI
188+
#' Encode a raster object as a data URI
189189
#'
190-
#' Convenient embedding images via [layout()]
191-
#' \href{images}{https://plot.ly/r/reference/#layout-images}.
190+
#' Encode a raster object as a data URI, which is suitable for
191+
#' use with `layout()` \href{https://plot.ly/r/reference/#layout-images}{images}.
192+
#' This is especially convenient for embedding raster images on a plot in
193+
#' a self-contained fashion (i.e., so they don't depend on external URL links).
192194
#'
193195
#' @param r an object coercable to a raster object via [as.raster()]
194196
#' @param ... arguments passed onto [as.raster()].
195197
#' @author Carson Sievert
196198
#' @export
199+
#' @references <https://plotly-r.com/embedding-images.html>
197200
#' @examples
198201
#'
199202
#' # a red gradient (from ?as.raster)

man/raster2uri.Rd

+8-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)