ReporteRs v0.8.2

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

Travis-CI Build Status Build status CRAN version

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

Details

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/ReporteRs)](http://www.rdocumentation.org/packages/ReporteRs)