Skip to content

Commit

Permalink
remove references to PDF in docs for prepare_figure()
Browse files Browse the repository at this point in the history
  • Loading branch information
neilstats committed Sep 13, 2024
1 parent 81a255c commit df7b92b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions R/save-figure.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
#' By default, plot will fill the space within margins.
#' @param valign If size is set, where to place figure within margins. 1 = top, 0.5 = middle, 0 = bottom. (Default: 0.5)
#' @param halign If size is set, where to place figure within margins. 1 = right, 0.5 = middle, 0 = left (Default: 0.5)
#' @param pagesize Page size of PDF output: "A4" or "A5". (Default: "A4")
#' @param pagesize Page size of output: "A4" or "A5". (Default: "A4")
#' @param landscape Landscape page orientation? (Default: False)
#' @param pagedim Dimensions (width, height) of PDF output. Overrides pagesize and landscape arguments if used.
#' @param pagedim Dimensions (width, height) of output. Overrides pagesize and landscape arguments if used.
#'
#' @export
#'
Expand Down Expand Up @@ -163,7 +163,7 @@ save_figure <- function(figure,
# Prepare figure
figure <- prepare_figure(figure, ...)

# Save to PDF file
# Save to file
figargs <- list(filename = filename,
plot = figure$page,
width = attr(figure$page, "width"),
Expand Down
4 changes: 2 additions & 2 deletions man/prepare_figure.Rd

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

0 comments on commit df7b92b

Please sign in to comment.