ReporteRs v0.5.4

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

Details

Type Package
Date 2014-04-10
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)