Make corporate reporting with minimum hassle
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.
The help pages are in a bookdown located at:
https://ardata-fr.github.io/officeverse/
Manuals are available at:
https://davidgohel.github.io/officer/.
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.
The function docx_summary() reads and imports content of a Word
document into a data.frame. The function handles paragraphs, tables and
section breaks.
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.
The pptx_summary() function reads and imports content of a PowerPoint
document into a data.frame. The function handles paragraphs, tables and
images.
The package flextable brings a full API to produce nice tables and use them with packages officer and rmarkdown.
The package rvg brings an API to
produce nice vector graphics that can be embedded in PowerPoint
documents or Excel workbooks with officer.
The package mschart combined
with officer can produce native office charts in PowerPoint and Word
documents.
You can get the development version from GitHub:
devtools::install_github("davidgohel/officer")Or the latest version on CRAN:
install.packages("officer")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.
Anyone getting involved in this package agrees to our Code of Conduct.
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.
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.