Skip to content

improve documentation for pdf_convert() #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ Suggests:
webp,
tesseract,
testthat
RoxygenNote: 6.1.1
RoxygenNote: 7.0.2
Roxygen: list(markdown = TRUE)
5 changes: 4 additions & 1 deletion R/render.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
#' # convert few pages to png
#' file.copy(file.path(Sys.getenv("R_DOC_DIR"), "NEWS.pdf"), "news.pdf")
#' pdf_convert("news.pdf", pages = 1:3)
#' # specify format string for output filenames
#' pdf_convert("news.pdf", filenames="news_page_%d.%s")
#'
#' # render into raw bitmap
#' bitmap <- pdf_render_page("news.pdf")
Expand Down Expand Up @@ -62,7 +64,8 @@ pdf_render_page<- function(pdf, page = 1, dpi = 72, numeric = FALSE, antialias =
#' to one of `poppler_config()$supported_image_formats`.
#' @param pages vector with one-based page numbers to render. `NULL` means all pages.
#' @param filenames vector of equal length to `pages` with output filenames. May also be
#' a format string which is expanded using `pages` and `format` respectively.
#' a format string which is expanded using `pages` and `format` respectively, i.e. `sprintf`-type
#' string containing `%d` and `%s` (in this order).
#' @param verbose print some progress info to stdout
pdf_convert <- function(pdf, format = "png", pages = NULL, filenames = NULL , dpi = 72,
antialias = TRUE, opw = "", upw = "", verbose = TRUE){
Expand Down
26 changes: 20 additions & 6 deletions man/pdf_ocr.Rd

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

37 changes: 29 additions & 8 deletions man/pdf_render_page.Rd

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

6 changes: 4 additions & 2 deletions man/pdftools.Rd

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

6 changes: 4 additions & 2 deletions man/qpdf.Rd

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