R: Manipulation of Microsoft Word and PowerPoint Documents

# Manipulation of Microsoft Word and PowerPoint Documents

## Documentation for package ‘officer’ version 0.7.5

- DESCRIPTION file.
- Package NEWS.

## Help Pages

A B C D E F H L M N O P R S T U W

officer-package | Manipulate Microsoft Word and PowerPoint Documents with 'officer'

## -- A --

add_sheet | Add a sheet
add_slide | Add a slide
annotate_base | Placeholder parameters annotation
as.matrix.rpptx | PowerPoint table to matrix

## -- B --

block_caption | Caption block
block_gg | 'ggplot' block
block_list | List of blocks
block_list_items | List of items for Word and PowerPoint
block_pour_docx | External Word document placeholder
block_section | Section for 'Word'
block_table | Table block
block_toc | Table of content for 'Word'
body_add_blocks | Add a list of blocks into a 'Word' document
body_add_break | Add a page break in a 'Word' document
body_add_caption | Add Word caption in a 'Word' document
body_add_docx | Add an external docx in a 'Word' document
body_add_fpar | Add fpar in a 'Word' document
body_add_gg | Add a 'ggplot' in a 'Word' document
body_add_img | Add an image in a 'Word' document
body_add_list | Add a list of items into a 'Word' document
body_add_par | Add paragraphs of text in a 'Word' document
body_add_plot | Add plot in a 'Word' document
body_add_table | Add table in a 'Word' document
body_add_toc | Add table of content in a 'Word' document
body_append_start_context | Fast Append context to a Word document
body_append_stop_context | Fast Append context to a Word document
body_bookmark | Add bookmark in a 'Word' document
body_comment | Add comment in a 'Word' document
body_end_block_section | Add any section
body_end_section_columns | Add multi columns section
body_end_section_columns_landscape | Add a landscape multi columns section
body_end_section_continuous | Add continuous section
body_end_section_landscape | Add landscape section
body_end_section_portrait | Add portrait section
body_import_docx | Import an external docx in a 'Word' document
body_remove | Remove an element in a 'Word' document
body_replace_all_text | Replace text anywhere in the document
body_replace_gg_at_bkm | Add plots at bookmark location in a 'Word' document
body_replace_img_at_bkm | Replace text at a bookmark location
body_replace_plot_at_bkm | Add plots at bookmark location in a 'Word' document
body_replace_text_at_bkm | Replace text at a bookmark location
body_set_default_section | Define Default Section

## -- C --

change_styles | Replace styles in a 'Word' Document
color_scheme | Color scheme of a PowerPoint file
cursor_backward | Set cursor in a 'Word' document
cursor_begin | Set cursor in a 'Word' document
cursor_bookmark | Set cursor in a 'Word' document
cursor_end | Set cursor in a 'Word' document
cursor_forward | Set cursor in a 'Word' document
cursor_reach | Set cursor in a 'Word' document
cursor_reach_index | Set cursor in a 'Word' document
cursor_reach_test | Set cursor in a 'Word' document

## -- D --

docx_bookmarks | List Word bookmarks
docx_comments | Get comments in a Word document as a data.frame
docx_dim | 'Word' page layout
docx_embed_font | Embed Fonts in a Word Document
docx_set_character_style | Add character style in a Word document
docx_set_paragraph_style | Add or replace paragraph style in a Word document
docx_set_settings | Set 'Microsoft Word' Document Settings
docx_show_chunk | Show underlying text tag structure
docx_summary | Get Word content in a data.frame
doc_properties | Read document properties

## -- E --

empty_content | Empty block for 'PowerPoint'
external_img | External image

## -- F --

floating_external_img | Floating external image
footers_replace_all_text | Replace text anywhere in the document
footers_replace_img_at_bkm | Replace text at a bookmark location
footers_replace_text_at_bkm | Replace text at a bookmark location
format.fp_cell | Cell formatting properties
format.fp_text | Text formatting properties
fpar | Formatted paragraph
fp_border | Border properties object
fp_cell | Cell formatting properties
fp_par | Paragraph formatting properties
fp_par_lite | Paragraph formatting properties
fp_tab | Tabulation mark properties object
fp_tabs | Tabs properties object
fp_text | Text formatting properties
fp_text_lite | Text formatting properties
ftext | Formatted chunk of text

## -- H --

headers_replace_all_text | Replace text anywhere in the document
headers_replace_img_at_bkm | Replace text at a bookmark location
headers_replace_text_at_bkm | Replace text at a bookmark location
hyperlink_ftext | Formatted chunk of text with hyperlink

## -- L --

layout_dedupe_ph_labels | Detect and handle duplicate placeholder labels
layout_default | Default layout for new slides
layout_properties | Slide layout properties
layout_rename_ph_labels | Change ph labels in a layout
layout_rename_ph_labels<- | Change ph labels in a layout
layout_summary | Presentation layouts summary
length.rdocx | Number of blocks inside an rdocx object
length.rpptx | Number of slides
length.rxlsx | Create an 'Excel' document object
list_item | Create a list item

## -- M --

media_extract | Extract media from a document object
move_slide | Move a slide

## -- N --

notes_location_label | Location of a named placeholder for notes
notes_location_type | Location of a placeholder for notes

## -- O --

officer | Manipulate Microsoft Word and PowerPoint Documents with 'officer'
on_slide | Change current slide
open_file | Opens a file locally

## -- P --

page_mar | Page margins object
page_size | Page size object
phs_with | Fill multiple placeholders using key value syntax
ph_hyperlink | Hyperlink a placeholder
ph_location | Location for a placeholder from scratch
ph_location_fullsize | Location of a full size element
ph_location_id | Location of a placeholder based on its id
ph_location_label | Location of a named placeholder
ph_location_left | Location of a left body element
ph_location_right | Location of a right body element
ph_location_template | Location for a placeholder based on a template
ph_location_type | Location of a placeholder based on a type
ph_remove | Remove a shape
ph_slidelink | Slide link to a placeholder
ph_with | Add objects on the current slide
ph_with.block_list | Add objects on the current slide
ph_with.block_list_items | Add objects on the current slide
ph_with.character | Add objects on the current slide
ph_with.data.frame | Add objects on the current slide
ph_with.Date | Add objects on the current slide
ph_with.empty_content | Add objects on the current slide
ph_with.external_img | Add objects on the current slide
ph_with.factor | Add objects on the current slide
ph_with.fpar | Add objects on the current slide
ph_with.gg | Add objects on the current slide
ph_with.logical | Add objects on the current slide
ph_with.numeric | Add objects on the current slide
ph_with.plot_instr | Add objects on the current slide
ph_with.unordered_list | Add objects on the current slide
ph_with.xml_document | Add objects on the current slide
plot_instr | Wrap plot instructions for png plotting in Powerpoint or Word
plot_layout_properties | Slide layout properties plot
pptx_summary | PowerPoint content in a data.frame
print.fp_cell | Cell formatting properties
print.fp_par | Paragraph formatting properties
print.fp_text | Text formatting properties
print.rdocx | Write a 'Word' File
print.rpptx | Write a 'PowerPoint' file.
print.rtf | Write an 'RTF' File
print.rxlsx | Create an 'Excel' document object
print.sp_line | Line properties
print.sp_lineend | Line end properties
prop_section | Section properties
prop_table | Table properties

## -- R --

read_docx | Create a 'Word' document object
read_pptx | Create a 'PowerPoint' document object
read_xlsx | Create an 'Excel' document object
remove_slide | Remove slide(s)
rtf_add | Add content into an RTF document
rtf_add.block_list | Add content into an RTF document
rtf_add.block_section | Add content into an RTF document
rtf_add.block_toc | Add content into an RTF document
rtf_add.character | Add content into an RTF document
rtf_add.double | Add content into an RTF document
rtf_add.factor | Add content into an RTF document
rtf_add.fpar | Add content into an RTF document
rtf_add.gg | Add content into an RTF document
rtf_add.plot_instr | Add content into an RTF document
rtf_doc | Create an RTF document object
rtf_set_paragraph_style | Add or replace a paragraph style in an RTF document
rtf_styles_info | Read paragraph styles defined on an RTF document
run_autonum | Auto number
run_bookmark | Bookmark for 'Word'
run_columnbreak | Column break for 'Word'
run_comment | Comment for 'Word'
run_footnote | Footnote for 'Word'
run_footnoteref | Word footnote reference
run_linebreak | Page break for 'Word'
run_pagebreak | Page break for 'Word'
run_reference | Cross reference
run_tab | Tab for 'Word'
run_wordtext | Word chunk of text with a style
run_word_field | 'Word' computed field

## -- S --

section_columns | Section columns
set_autonum_bookmark | Update bookmark of an autonumber run
set_doc_properties | Set document properties
set_notes | Set notes for current slide
set_notes.block_list | Set notes for current slide
set_notes.character | Set notes for current slide
sheet_add_drawing | Add a drawing to an Excel sheet
sheet_names | Sheet names of an xlsx workbook
sheet_remove | Remove a sheet
sheet_select | Select sheet
sheet_write_data | Write data to a sheet
shortcuts | shortcuts for formatting properties
slide_size | Slides width and height
slide_summary | Slide content in a data.frame
slide_visible | Get or set slide visibility
slide_visible<- | Get or set slide visibility
sp_line | Line properties
sp_lineend | Line end properties
styles_info | Read 'Word' styles

## -- T --

table_colwidths | Column widths of a table
table_conditional_formatting | Table conditional formatting
table_layout | Algorithm for table layout
table_stylenames | Paragraph styles for columns
table_width | Preferred width for a table
to_pml.sp_line | Line properties

## -- U --

unordered_list | Unordered list
update.fpar | Formatted paragraph
update.fp_border | Border properties object
update.fp_cell | Cell formatting properties
update.fp_par | Paragraph formatting properties
update.fp_text | Text formatting properties
update.sp_line | Line properties
update.sp_lineend | Line end properties

## -- W --

write_elements_to_context | Fast Append context to a Word document