# Manipulation of Microsoft Word and PowerPoint Documents

## Documentation for package ‘officer’ version 0.3.12

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

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

officer-package | officer: Manipulate Microsoft Word and PowerPoint Documents

## -- A --

add_sheet | add a sheet
add_slide | add a slide
annotate_base | PowerPoint placeholder parameters annotation

## -- B --

block_caption | Caption block
block_list | Create paragraph blocks
block_pour_docx | Pour external Word document in the current document
block_section | New Word section
block_table | Table block
block_toc | Table of content
body_add | Add content into a Word document
body_add.block_caption | Add content into a Word document
body_add.block_list | Add content into a Word document
body_add.block_pour_docx | Add content into a Word document
body_add.block_section | Add content into a Word document
body_add.block_toc | Add content into a Word document
body_add.character | Add content into a Word document
body_add.data.frame | Add content into a Word document
body_add.external_img | Add content into a Word document
body_add.factor | Add content into a Word document
body_add.fpar | Add content into a Word document
body_add.gg | Add content into a Word document
body_add.numeric | Add content into a Word document
body_add.plot_instr | Add content into a Word document
body_add.run_columnbreak | Add content into a Word document
body_add.run_pagebreak | Add content into a Word document
body_add_blocks | add a list of blocks into a document
body_add_break | add page break
body_add_docx | insert an external docx
body_add_fpar | add fpar
body_add_gg | add ggplot
body_add_img | add image
body_add_par | add paragraph of text
body_add_table | add table
body_add_toc | add table of content
body_add_xml | add an xml string as document element
body_bookmark | add bookmark
body_default_section | Defunct Functions in Package officer
body_end_block_section | add any section
body_end_section | Defunct Functions in Package officer
body_end_section_columns | add multi columns section
body_end_section_columns_landscape | add multi columns section within landscape orientation
body_end_section_continuous | add continuous section
body_end_section_landscape | add landscape section
body_end_section_portrait | add portrait section
body_remove | remove an element
body_replace_all_text | Replace text anywhere in the document, or at a cursor
body_replace_img_at_bkm | replace text at a bookmark location
body_replace_text_at_bkm | replace text at a bookmark location
break_column_before | Defunct Functions in Package officer

## -- C --

change_styles | replace paragraphs styles
color_scheme | color scheme
cursor_backward | set cursor in an rdocx object
cursor_begin | set cursor in an rdocx object
cursor_bookmark | set cursor in an rdocx object
cursor_end | set cursor in an rdocx object
cursor_forward | set cursor in an rdocx object
cursor_reach | set cursor in an rdocx object

## -- D --

docx_body_relationship | body xml document
docx_body_xml | body xml document
docx_bookmarks | List Word bookmarks
docx_dim | Word page layout
docx_reference_img | add images into an rdocx object
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 | create empty blocks
external_img | external image

## -- F --

footers_replace_all_text | Replace text anywhere in the document, or at a cursor
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
fortify_location | eval a location on the current slide
fpar | Concatenate formatted text as a paragraph
fp_border | border properties object
fp_cell | Cell formatting properties
fp_par | Paragraph formatting properties
fp_text | Text formatting properties
ftext | formatted chunk of text

## -- G --

get_reference_value | Get the document being used as a template

## -- H --

headers_replace_all_text | Replace text anywhere in the document, or at a cursor
headers_replace_img_at_bkm | replace text at a bookmark location
headers_replace_text_at_bkm | replace text at a bookmark location

## -- L --

layout_properties | slide layout properties
layout_summary | presentation layouts summary
length.rdocx | number of blocks inside an rdocx object
length.rpptx | number of slides
length.rxlsx | open a connexion to an 'Excel' file

## -- M --

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

## -- O --

officer | officer: Manipulate Microsoft Word and PowerPoint Documents
officer-defunct | Defunct Functions in Package officer
on_slide | change current slide
opts_current_table | Get table options in a 'knitr' context

## -- P --

pack_folder | compress a folder
page_mar | page margins object
page_size | page size object
ph_add_fpar | append fpar
ph_add_par | append paragraph
ph_add_text | append text
ph_empty | add a new empty shape
ph_empty_at | add a new empty shape
ph_from_xml | Defunct Functions in Package officer
ph_from_xml_at | Defunct Functions in Package officer
ph_hyperlink | hyperlink a placeholder
ph_location | create a location for a placeholder
ph_location_fullsize | location of a full size element
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 | create a 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 into a new shape on the current slide
ph_with.block_list | add objects into a new shape on the current slide
ph_with.character | add objects into a new shape on the current slide
ph_with.data.frame | add objects into a new shape on the current slide
ph_with.empty_content | add objects into a new shape on the current slide
ph_with.external_img | add objects into a new shape on the current slide
ph_with.factor | add objects into a new shape on the current slide
ph_with.fpar | add objects into a new shape on the current slide
ph_with.gg | add objects into a new shape on the current slide
ph_with.logical | add objects into a new shape on the current slide
ph_with.numeric | add objects into a new shape on the current slide
ph_with.plot_instr | add objects into a new shape on the current slide
ph_with.unordered_list | add objects into a new shape on the current slide
ph_with.xml_document | add objects into a new shape on the current slide
ph_with_fpars_at | Defunct Functions in Package officer
ph_with_gg | Defunct Functions in Package officer
ph_with_gg_at | add ggplot to a pptx presentation
ph_with_img | Defunct Functions in Package officer
ph_with_img_at | add image
ph_with_table | Defunct Functions in Package officer
ph_with_table_at | Defunct Functions in Package officer
ph_with_text | add text into a new shape
ph_with_ul | Defunct Functions in Package officer
plot_instr | Wrap plot instructions for png plotting in Powerpoint or Word
plot_layout_properties | Plot slide layout properties
pptx_summary | get 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 | Create a 'Word' document object
print.rpptx | write a 'PowerPoint' file.
print.rxlsx | open a connexion to an 'Excel' file
prop_section | section properties
prop_table | Table properties

## -- R --

read_docx | Create a 'Word' document object
read_pptx | open a connexion to a 'PowerPoint' file
read_xlsx | open a connexion to an 'Excel' file
remove_slide | remove a slide
run_autonum | auto number
run_columnbreak | column break
run_linebreak | page break for Word
run_pagebreak | page break for Word
run_reference | reference
run_seqfield | seqfield

## -- S --

sanitize_images | remove unused media from a document
section_columns | section columns
set_doc_properties | set document properties
sheet_select | select sheet
shortcuts | shortcuts for formatting properties
slide_size | slides width and height
slide_summary | get PowerPoint slide content in a data.frame
slip_in_column_break | add a column break
slip_in_footnote | append a footnote
slip_in_img | append an image
slip_in_seqfield | append seq field
slip_in_text | append text
slip_in_xml | add a wml string into a Word document
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_width | Preferred width for a table
to_html | Convert officer objects to HTML
to_pml | Convert officer objects to PresentationML
to_wml | Convert officer objects to WordprocessingML

## -- U --

unordered_list | Unordered list
unpack_folder | Extract files from a zip file
update.fpar | Concatenate formatted text as a 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

## -- W --

wml_link_images | transform an xml string with images references