ReporteRs v0.7.9

by David Gohel View Source

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.2 ♦ ReporteRs 0.7.5

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

Details

Type Package
Date 2015-03-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
suggests ggplot2
depends R (>= 3.0) , ReporteRsjars (>= 0.0.2)
imports rJava
Contributors Bootstrap, jQuery, Dmitry Baranovskiy

Include our badge in your README

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

API documentation
R package
Rdocumentation.org

Created by DataCamp.com

Learn R at work Try it free