ReporteRs v0.3

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.

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")
if( !require( highlight ) ) install.packages("highlight")

From sources

From an R console (R >= 3.0):

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

Binary package

Packages are available here: https://github.com/davidgohel/ReporteRsjars/releases/tag/v0.1 https://github.com/davidgohel/ReporteRs/releases/tag/v0.3

Getting Started

Help: http://davidgohel.github.io/ReporteRs/index.html

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
FlexCell Cell object for FlexTable
addFooter Insert a footer into a document object
FontMetric Font metric
addFlexTable Insert a FlexTable into a document object
FlexTable FlexTable
addFooterRow add footer in a FlexTable
addPageBreak Add a page break into a document object
addFlexTable.pptx Insert a FlexTable into a docx object
setFlexCellContent Replace FlexTable content
declareTitlesStyles Set manually headers'styles of a document object
addParagraph.docx Insert a paragraph into a docx object
addTOC Add a table of contents into a document object
print.textProperties print formating properties
addPageNumber Insert a page number into a document object
addImage.pptx Insert an external image into a pptx object
styles.docx Get styles names of a docx document
addPlot.html Add a plot into an html object
slide.layouts Get layout names of a document object
addTOC.docx Insert a table of contents into a docx object
addSlide Add a slide into a document object
pptx Create Microsoft PowerPoint document object representation
writeDoc.pptx Write a pptx object in a pptx file
get.darker.tableProperties get a darker tableProperties
addParagraph.html Insert a paragraph into an html object
cellProperties Cell formating properties
addRScript Add R script into a document object
data_ReporteRs Dummy dataset used in ReporterRs examples
add.pot add a paraggraph to an existing set of paragraphs of text
addTable Add a table into a document object
addTitle.docx Insert a title into a docx object
textProperties Text formating properties
addDate.pptx Insert a date shape into a document pptx object
print.pptx print informations about an object of class "pptx".
slide.layouts.pptx Get layout names of a pptx document
addPlot.pptx Add a plot into a pptx object
print.docx print informations about an object of class "docx".
parProperties Paragraph formating properties
addImage Add an external image into a document object
gforge_datacopy melanoma dataset from boot package
is.color color checking
addFlexTable.html Insert a FlexTable into a docx object
addPage Add a page into a document object
addPageBreak.docx Insert a page break into a docx object
addPlot.docx Add a plot into a docx object
tableProperties Table formating properties
print.html print informations about an object of class "html".
get.greenheader.tableProperties get a green header tableProperties
[<-.FlexTable Format FlexTable content
addImage.docx Insert external images into a docx object
addSlide.pptx Insert a slide into a pptx object
addSubtitle.pptx Insert a addSubtitle shape into a pptx object
Paragraph Paragraph (internal use only)
addPage.html Insert a page into an html object
addSubtitle Add a subtitle shape into a document object
addImage.html Insert an external image into a html object
deleteBookmarkNextContent delete first content after a bookmark into a docx object
+.pot pot concatenation
pot Piece of Text (formated text)
writeDoc.html Write a html object in a html file
set_of_paragraphs Set of paragraphs of text
styles Get styles names of a document object
ParagraphSection ParagraphSection (internal use only)
registerRaphaelGraph register Raphael plots
get.light.tableProperties get a 'lighter' tableProperties
addTable.pptx Insert a table into an pptx object
addTitle Add a title into a document object
addParagraph Add a paragraph into a document object
declareTitlesStyles.docx Set manually headers'styles of a docx object
deleteBookmark delete a bookmark into a docx object
docx Create Microsoft Word document object representation
addPlot Add a plot into a document object
addPageNumber.pptx Insert a page number shape into a document pptx object
FlexRow Row object for FlexTable
addDate Insert a date into a document object
addFooter.pptx Insert a footer shape into a document pptx object
html Create an HTML document object representation
addFlexTable.docx Insert a FlexTable into a docx object
addTable.html Insert a table into an html object
writeDoc Write a document object
addTable.docx Insert a table into a docx object
addRScript.html Add R script into a html object
addTitle.html Insert a title into a html object
get.default.tableProperties get default tableProperties
writeDoc.docx Write a docx object in a docx file
addHeaderRow add header in a FlexTable
ReporteRs-package ReporteRs: a package to create document from R
addParagraph.pptx Insert a paragraph into a pptx object
addTitle.pptx Insert a title into a pptx object
[<-.FlexTable Format FlexTable content
No Results!

Details

Type Package
Date 2014-03-01
License GPL-3
Copyright See file COPYRIGHTS.
SystemRequirements java (>= 1.6)
URL 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)