officer v0.3.6

0

Monthly downloads

0th

Percentile

Manipulation of Microsoft Word and PowerPoint Documents

Access and manipulate 'Microsoft Word' and 'Microsoft PowerPoint' documents from R. The package focuses on tabular and graphical reporting from R; it also provides two functions that let users get document content into data objects. A set of functions lets add and remove images, tables and paragraphs of text in new or existing documents. When working with 'PowerPoint' presentations, slides can be added or removed; shapes inside slides can also be added or removed. When working with 'Word' documents, a cursor can be used to help insert or delete content at a specific location in the document. The package does not require any installation of Microsoft products to be able to write Microsoft files.

Readme

officer R package

The officer package lets R users manipulate Word (.docx) and PowerPoint (*.pptx) documents. In short, one can add images, tables and text into documents from R. An initial document can be provided; contents, styles and properties of the original document will then be available.

Make corporate reporting with minimum hassle

Travis-CI Build
Status Build
status version cranlogs codecov Active

Word documents

The read_docx() function will read an initial Word document (an empty one by default) and lets you modify its content later.

The package provides functions to add R outputs into a Word document:

  • images: produce your plot in png or emf files and add them into the document, as a whole paragraph or inside a paragraph.
  • tables: add data.frames as tables, format is defined by the associated Word table style.
  • text: add text as paragraphs or inside an existing paragraph, format is defined by the associated Word paragraph and text styles.
  • field codes: add Word field codes inside paragraphs. Field codes is an old feature of MS Word to create calculated elements such as tables of contents, automatic numbering and hyperlinks.

In a Word document, one can use cursor functions to reach the beginning or end of a document, or a particular paragraph containing a given text. This cursor concept has been implemented to make the post processing of files easier.

File generation is performed with the print function.

import Word document in a data.frame

The function docx_summary() reads and imports content of a Word document into a data.frame. The function handles paragraphs, tables and section breaks.

PowerPoint documents

The function read_pptx() will read an initial PowerPoint document (an empty one by default) and let you modify its content later.

The package provides functions to add R outputs into existing or new PowerPoint slides:

  • images: produce your plot in png or emf files and add them in a slide.
  • tables: add data.frames as tables, format is defined by the associated PowerPoint table style.
  • text: add text as paragraphs or inside an existing paragraph, format is defined in the corresponding layout of the slide.

In a PowerPoint document, one can set a slide as selected and reach a particular shape (and remove it or add text).

File generation is performed with the print() function.

import PowerPoint document in a data.frame

The pptx_summary() function reads and imports content of a PowerPoint document into a tibble object. The function handles paragraphs, tables and images.

Extensions

Tables and package flextable

The package flextable brings a full API to produce nice tables and use them with officer. Tables can be written in PowerPoint documents and Word documents. An option is available to render flextables in rmarkdown (HTML and Word outputs).

Vector graphics with package rvg

The package rvg brings an API to produce nice vector graphics that can be embedded in PowerPoint documents or Excel workbooks with officer.

Native office charts with package mschart

The package mschart combined with officer can produce native office charts in PowerPoint and Word documents.

Installation

You can get the development version from GitHub:

devtools::install_github("davidgohel/officer")

Or the latest version on CRAN:

install.packages("officer")

Resources

Online documentation

The help pages are located at https://davidgohel.github.io/officer/.

Getting help

If you have questions about how to use the package, visit Stack Overflow’s officer tag and post your question there. I usually read them and answer when possible.

Contributing to the package

Code of Conduct

Anyone getting involved in this package agrees to our Code of Conduct.

Bug reports

When you file a bug report, please spend some time making it easy for me to follow and reproduce. The more time you spend on making the bug report coherent, the more time I can dedicate to investigate the bug as opposed to the bug report.

Contributing to the package development

A great way to start is to contribute an example or improve the documentation.

If you want to submit a Pull Request to integrate functions of yours, please provide:

  • the new function(s) with code and roxygen tags (with examples)
  • a new section in the appropriate vignette that describes how to use the new function
  • add corresponding tests in directory tests/testthat.

By using rhub (run rhub::check_for_cran()), you will see if everything is ok. When submitted, the PR will be evaluated automatically on travis and appveyor and you will be able to see if something broke.

Functions in officer

Name Description
body_add_toc add table of content
body_add_table add table
body_add_par add paragraph of text
docx_dim Word page layout
docx_reference_img add images into an rdocx object
body_add_xml add an xml string as document element
color_scheme color scheme
fortify_location eval a location on the current slide
external_img external image
cursor_begin set cursor in an rdocx object
body_remove remove an element
body_replace_all_text Replace text anywhere in the document, or at a cursor
docx_bookmarks List Word bookmarks
ftext formatted text
docx_body_xml body xml document
layout_properties slide layout properties
body_replace_text_at_bkm replace text at a bookmark location
ph_add_par append paragraph
ph_add_fpar append fpar
change_styles replace paragraphs styles
ph_location_right location of a right body element
on_slide change current slide
ph_location_template create a location for a placeholder based on a template
add_slide add a slide
pack_folder compress a folder
fp_par Paragraph formatting properties
body_bookmark add bookmark
fp_text Text formatting properties
body_end_section add section
docx_body_relationship body xml document
doc_properties read document properties
fpar concatenate formatted text as a paragraph
ph_location_fullsize location of a full size element
ph_location create a location for a placeholder
read_docx open a connection to a 'Word' file
ph_with_ul add unordered list to a pptx presentation
ph_with_text add text into a new shape
read_pptx open a connexion to a 'PowerPoint' file
ph_with_img add image
print.rpptx write a 'PowerPoint' file.
ph_with_table add table
pptx_summary get PowerPoint content in a data.frame
docx_show_chunk Show underlying text tag structure
docx_summary get Word content in a data.frame
fp_border border properties object
fp_cell Cell formatting properties
slip_in_xml add a wml string into a Word document
location_eval Utility to eval a location
slide_summary get PowerPoint slide content in a data.frame
move_slide move a slide
ph_add_text append text
officer officer: Manipulate Microsoft Word and PowerPoint Documents
break_column_before add a column break
fp_sign object unique signature
layout_summary presentation layouts summary
length.rpptx number of slides
ph_empty add a new empty shape
styles_info read Word styles
ph_from_xml add an xml string as new shape
ph_hyperlink hyperlink a placeholder
media_extract Extract media from a document object
ph_location_label location of a named placeholder
ph_with_fpars_at add multiple formated paragraphs
ph_with add objects into a new shape on the current slide
ph_location_left location of a left body element
ph_slidelink slide link to a placeholder
set_doc_properties set document properties
ph_location_type location of a placeholder based on a type
ph_with_gg add ggplot to a pptx presentation
sheet_select select sheet
slip_in_seqfield append seq field
slip_in_text append text
shortcuts shortcuts for formatting properties
read_xlsx open a connexion to an 'Excel' file
remove_slide remove a slide
unordered_list unordered list
slide_size slides width and height
ph_remove remove a shape
unpack_folder Extract files from a zip file
sanitize_images remove unused media from a document
sections sections
slip_in_img append an image
slip_in_footnote append a footnote
wml_link_images transform an xml string with images references
add_sheet add a sheet
body_add_docx insert an external docx
body_add_img add image
body_add_gg add ggplot
body_add_break add page break
body_add_blocks add a list of blocks into a document
block_list create paragraph blocks
annotate_base PowerPoint placeholder parameters annotation
body_add_fpar add fpar
No Results!

Vignettes of officer

Name
overview.Rmd
No Results!

Last month downloads

Details

Type Package
License GPL-3
LazyData TRUE
LinkingTo Rcpp
URL https://davidgohel.github.io/officer
Encoding UTF-8
BugReports https://github.com/davidgohel/officer/issues
RoxygenNote 6.1.1
VignetteBuilder knitr
NeedsCompilation yes
Packaged 2019-11-11 15:28:04 UTC; davidgohel
Repository CRAN
Date/Publication 2019-11-11 16:00:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/officer)](http://www.rdocumentation.org/packages/officer)