ReporteRs v0.8.0

Microsoft Word, Microsoft Powerpoint and HTML Documents Generation

Create 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 an 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('davidgohel/ReporteRsjars')
devtools::install_github('davidgohel/ReporteRs')

Get the latest Windows binary packages:
ReporteRsjars 0.2ReporteRs 0.8.0

install.packages("C:/path/ReporteRsjars_x.x.x.zip", repos = NULL,type="win.binary")
install.packages("C:/path/ReporteRs_x.x.x.zip", repos = NULL,type="win.binary")

Getting Started

library(ReporteRs)

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

?ReporteRs
?addFlexTable
?addPlot
?addMarkdown
?addParagraph
?docx
?pptx
?bsdoc

License

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

Functions in ReporteRs

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

Details

Type Package
Date 2015-04-15
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)