forked from davidgohel/officer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
82 lines (52 loc) · 3.52 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
---
title: "officer R package"
output:
github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
message = FALSE,
collapse = TRUE,
comment = "#>"
)
```
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.
*This package is close to ReporteRs as it produces Word and PowerPoint files but it is faster, do not require `rJava` (but `xml2`) and has less functions that will make it easier to maintain.*
[](https://travis-ci.org/davidgohel/officer)
[](https://CRAN.R-project.org/package=officer)
[](https://codecov.io/github/davidgohel/officer?branch=master)
[](http://www.repostatus.org/#wip)
## Word documents
Function `read_docx` will read an initial Word document (an empty one by default) and let 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 content, automatic numbering and hyperlinks.
In a Word document, one can use cursor functions to reach the beginning of a document, its end or a particular paragraph containing a given text. This *cursor* concept has been implemented to make easier the post processing of files.
The file generation is performed with function `print`.
### import Word document in a data.frame
Function `fortify_docx` read and import content of a Word document into
a tibble object. The function handles paragraphs, tables and section breaks.
## PowerPoint documents
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).
The file generation is performed with function `print`.
### Tables and package `flextable`
The package [flextable](https://github.com/davidgohel/flextable) brings a full API to produce nice tables and use them with `officer`.
## Installation
You can get the development version from GitHub:
```{r eval = FALSE}
devtools::install_github("davidgohel/officer")
```
Or the latest version on CRAN:
```{r eval = FALSE}
install.packages("officer")
```