ReporteRs v0.5.5

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

Details

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