Skip to content

Commit

Permalink
gt_render_image in pkgdown only
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcaseb committed Aug 20, 2024
1 parent 1e62d66 commit 4074a0b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions R/gt_nfl.R
Original file line number Diff line number Diff line change
Expand Up @@ -308,13 +308,13 @@ gt_nfl_headshots <- function(gt_object,
#' running even if the chromote session is closed. Unfortunately, this causes
#' R CMD Check errors related to open connections after example runs. The only
#' way to avoid this is setting the environment variable `_R_CHECK_CONNECTIONS_LEFT_OPEN_`
#' to `"true"`. How to do that depends on where and how developers check their
#' to `"false"`. How to do that depends on where and how developers check their
#' package. A good way to prevent an example from being executed because the
#' environment variable was not set can be taken from the source code of this
#' function.
#' environment variable was not set to `"false"` can be taken from the source
#' code of this function.
#' @return Returns `NULL` invisibly.
#' @export
#' @examplesIf identical(Sys.getenv("_R_CHECK_CONNECTIONS_LEFT_OPEN_"), "false")
#' @examplesIf identical(Sys.getenv("_R_CHECK_CONNECTIONS_LEFT_OPEN_"), "false") && identical(Sys.getenv("IN_PKGDOWN"), "true")
#' tbl <- gt::gt_preview(mtcars)
#' gt_render_image(tbl)
gt_render_image <- function(gt_tbl, ...){
Expand Down
8 changes: 4 additions & 4 deletions man/gt_render_image.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4074a0b

Please sign in to comment.