doconv: to_miniature – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

to_miniature

Thumbnail of a document

Description

Convert a file into an image (magick image) where the pages are arranged in rows, each row can contain one to several pages.

The result can be saved as a png file.

Usage

to_miniature(
  filename,
  row = NULL,
  width = NULL,
  border_color = "#ccc",
  border_geometry = "2x2",
  fileout = NULL,
  use_docx2pdf = FALSE
)

Arguments

`filename`	input filename, a 'Microsoft Word' or a 'Microsoft Word' or a 'PDF' document.
`row`	row index for every pages. 0 are to be used to drop the page from the final minature. `c(1, 1)` is to be used to specify that a 2 pages document is to be displayed in a single row with two columns. `c(1, 1, 2, 3, 3)` is to be used to specify that a 5 pages document is to be displayed as: first row with pages 1 and 2, second row with page 3, third row with pages 4 and 5. `c(1, 1, 0, 2, 2)` is to be used to specify that a 5 pages document is to be displayed as: first row with pages 1 and 2, second row with pages 4 and 5.
`width`	width of a single image, recommanded values are: 650 for docx files 750 for pptx files
`border_color`	border color, see `image_border()`.
`border_geometry`	border geometry to be added around images, see `image_border()`.
`fileout`	if not NULL, result is saved in a png file whose filename is defined by this argument.
`use_docx2pdf`	if TRUE (and if 'Microsoft Word' executable can be found as well as 'docx2pdf'), docx2pdf will be used to convert 'Word' documents to PDF. This makes it possible to have a PDF identical to the 'Word' display whereas with 'LibreOffice', this is not always the case.

Value

a magick image object as returned by image_read().

Examples

library(locatexec)
docx_file <- system.file(
  package = "doconv",
  "doc-examples/example.docx"
)
if(exec_available("python") && docx2pdf_available())
  to_miniature(docx_file, use_docx2pdf = TRUE)

pptx_file <- system.file(
  package = "doconv",
  "doc-examples/example.pptx"
)
if(exec_available("libreoffice") && check_libreoffice_export())
  to_miniature(pptx_file)

doconv

Document Conversion to 'PDF' or 'PNG'

v0.1.2

MIT + file LICENSE

Authors

David Gohel [aut, cre], ArData [cph]

Initial release