ReporteRs v0.5.8

Microsoft Word, Microsoft Powerpoint and HTML documents generation from R

An R package for creating Microsoft Word document (>=2007), Microsoft Powerpoint document (>=2007) and HTML documents from R. There are several features to let you format and present R outputs ; e.g. Editable Vector Graphics, functions for complex tables reporting, reuse of corporate template document (*.docx and *.pptx). You can use the package as a tool for fast reporting and as a tool for reporting automation. The package does not require any installation of Microsoft product to be able to write Microsoft files (docx and pptx).

Readme

ReporteRs

ReporteRs is a R package for creating Microsoft Word, Microsoft Powerpoint and HTML documents from R.

Documentation can be found here.

Features

  • Create docx, pptx or html files with only a few lines of R code.
  • Add tables, plots, text or tables of contents into Word, PowerPoint and html documents.
  • Customize formatting of R output.
  • Take advantage of the benefits of reproducible research.

Installation

Dependencies

Java (it has been tested with java version >= 1.6).

ReporteRs needs some R packages ; run the following script to install them if needed.

if( !require( rJava ) ) install.packages("rJava")
if( !require( ggplot2 ) ) install.packages("ggplot2")
if( !require( base64 ) ) install.packages("base64")

CRAN

install.packages("ReporteRs")

Github

Get the latest release:

if( !require( devtools ) ) install.packages("devtools")
devtools::install_github('ReporteRsjars', 'davidgohel')
devtools::install_github('ReporteRs', 'davidgohel')

Get the latest binary packages: ReporteRsjars - ReporteRs

Getting Started

library(ReporteRs)

example(docx) #run a complete and detailed docx example
example(pptx) #run a complete and detailed pptx example
example(html) #run a complete and detailed html example

?ReporteRs
?addTable
?FlexTable
?addPlot
?addParagraph
?docx
?pptx
?html

License

The ReporteRs package is licensed under the GPLv3. See COPYRIGHTS file in the inst directory for additional details.

Functions in ReporteRs

Name Description
addDate Insert a date into a document object
addImage.html Insert an external image into a html object
as.html get HTML code
addPlot.html Add a plot into an html object
addFlexTable.html Insert a FlexTable into a docx object
Paragraph Paragraph (internal use only)
FlexRow Row object for FlexTable
addTOC Add a table of contents into a document object
addPageBreak.docx Insert a page break into a docx object
addSlide.pptx Insert a slide into a pptx object
add.pot add a paraggraph to an existing set of paragraphs of text
parCenter shortcut for centered alignment
FlexTable FlexTable creation
add.plot.interactivity add interactivity on a plot
FlexCell Cell object for FlexTable
[<-.FlexRow modify FlexRow content
addTOC.docx Insert a table of contents into a docx object
get.darker.tableProperties get a darker tableProperties
addFooterRow add footer in a FlexTable
addFooter Insert a footer into a document object
addPageNumber Insert a page number into a document object
addPageBreak Add a page break into a document object
FontMetric Font metric
addPlot.pptx Add a plot into a pptx object
addFlexTable.pptx Insert a FlexTable into a pptx object
addTable Add a table into a document object
addPageNumber.pptx Insert a page number shape into a document pptx object
textProperties Text formatting properties
addImage.pptx Insert an external image into a pptx object
addFlexTable.docx Insert a FlexTable into a docx object
addSubtitle Add a subtitle shape into a document object
chprop Change a formatting properties object
[<-.FlexTable alter FlexTable content and format
addTitle.docx Insert a title into a docx object
addTable.pptx Insert a table into an pptx object
dim.docx Get page layout dimensions of a Word document
ParagraphSection ParagraphSection (internal use only)
addPage.html Insert a page into an html object
addRScript.pptx Add R script into a pptx object
as.html.RScript get HTML code from a RScript object
as.html.FlexTable get HTML code from a FlexTable
print.docx print informations about an object of class "docx".
addTitle.pptx Insert a title into a pptx object
addParagraph Add a paragraph into a document object
get.default.tableProperties get default tableProperties
dim.pptx Get layout information on a PowerPoint slide
addFlexTable Insert a FlexTable into a document object
addPlot.docx Add a plot into a docx object
pptx Create Microsoft PowerPoint document object representation
addPlot Add a plot into a document object
addPage Add a page into a document object
addFooter.pptx Insert a footer shape into a document pptx object
slide.layouts.pptx Get layout names of a pptx document
setFlexTableBorders change grid lines of a FlexTable
docx-bookmark docx bookmarks
addRScript Add R script into a document object
addRScript.docx Add R script into a docx object
addRScript.html Add R script into a html object
spanFlexTableColumns Span columns within rows
addSubtitle.pptx Insert a addSubtitle shape into a pptx object
RScript RScript object
setFlexTableWidths set columns widths of a FlexTable
as.html.pot get HTML code from a pot
toc.options.docx Set TOC options
addHeaderRow add header in a FlexTable
parRight shortcut for right alignment
addParagraph.html Insert a paragraph into an html object
ReporteRs-package ReporteRs: a package to create document from R
addImage Add an external image into a document object
declareTitlesStyles Set manually headers'styles of a document object
borderDashed shortcut for dashed border
toc.options Set TOC options for a document object
addImage.docx Insert external images into a docx object
addDate.pptx Insert a date shape into a document pptx object
addPostCommand add post plot commands
addTitle.html Insert a title into a html object
borderProperties border properties object
get.light.tableProperties get a 'lighter' tableProperties
addParagraph.pptx Insert a paragraph into a pptx object
borderSolid shortcut for solid border
addTable.html Insert a table into an html object
addParagraph.docx Insert a paragraph into a docx object
get.greenheader.tableProperties get a green header tableProperties
html Create an HTML document object representation
chprop.cellProperties Modify a cell formatting properties object
cellProperties Cell formatting properties
spanFlexTableRows Span rows within columns
deleteBookmark delete a bookmark into a docx object
declareTitlesStyles.docx Set manually headers'styles of a docx object
borderDotted shortcut for dotted border
chprop.parProperties Modify paragraph formatting properties
addTitle Add a title into a document object
print.textProperties print formatting properties
+.pot pot concatenation
registerRaphaelGraph register Raphael plots
parJustify shortcut for justified alignment
styles Get styles names of a document object
setRowsColors applies background colors to rows of a FlexTable
print.pptx print informations about an object of class "pptx".
addSlide Add a slide into a document object
pbc_summary pbc summary
pot Piece of Text (formated text)
raphael.html get HTML code from a plot
deleteBookmarkNextContent delete first content after a bookmark into a docx object
styles.docx Get styles names of a docx document
chprop.textProperties Modify text formatting properties
addTable.docx Insert a table into a docx object
triggerPostCommand trigger post plot commands
set_of_paragraphs Set of paragraphs of text
slide.layouts Get layout names of a document object
is.color color checking
textItalic shortcut for italic
writeDoc.html Write a html object in a html file
parLeft shortcut for left alignment
parProperties Paragraph formatting properties
tableProperties Table formatting properties
writeDoc Write a document object
borderNone shortcut for no border
writeDoc.pptx Write a pptx object in a pptx file
setZebraStyle FlexTable rows zebra striping
textNormal shortcut for default textProperties
print.html print informations about an object of class "html".
data_ReporteRs Dummy dataset used in ReporterRs examples
docx Create Microsoft Word document object representation
writeDoc.docx Write a docx object in a docx file
textBoldItalic shortcut for bold italic
textBold shortcut for bold
setColumnsColors applies background colors to columns of a FlexTable
No Results!

Details

Type Package
Date 2014-07-11
License GPL-3
Copyright See file COPYRIGHTS.
SystemRequirements java (>= 1.6)
URL http://davidgohel.github.io/ReporteRs/index.html
BugReports https://github.com/davidgohel/ReporteRs/issues

Include our badge in your README

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