ReporteRs v0.6.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.

Usefull links:

  • Help pages: Documentation
  • if you have questions, use the mailing list: Mailing list
  • Report a bug: Bug report. If you report a bug, try to send a reproducible example and don't forget to send the result of

      sessionInfo()
    

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 outputs.
  • Design and format any complex table

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")

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 Windows binary packages:
ReporteRsjars 0.2ReporteRs 0.6.8

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

Details

Type Package
Date 2014-11-06
License GPL-3
Copyright See file COPYRIGHTS.
SystemRequirements java (>= 1.6)
URL http://davidgohel.github.io/ReporteRs/index.html, http://groups.google.com/group/reporters-package
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)