ReporteRs v0.5.9
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.
Documentation can be found here.
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")
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 binary packages: ReporteRsjars - ReporteRs
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
?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 | |
FlexRow | Row object for FlexTable | |
FlexCell | Cell object for FlexTable | |
addFlexTable.pptx | Insert a FlexTable into a pptx object | |
addPageBreak | Add a page break into a document object | |
addPageBreak.docx | Insert a page break into a docx object | |
addPlot | Add a plot into a document object | |
addPlot.docx | Add a plot into a docx object | |
Paragraph | Paragraph (internal use only) | |
FlexTable | FlexTable creation | |
[<-.FlexRow | modify FlexRow content | |
addDate | Insert a date into a document object | |
addDate.pptx | Insert a date shape into a document pptx object | |
addImage.html | Insert an external image into a html object | |
addSubtitle.pptx | Insert a addSubtitle shape into a pptx object | |
addTOC | Add a table of contents into a document object | |
ParagraphSection | ParagraphSection (internal use only) | |
FontMetric | Font metric | |
addFooter | Insert a footer into a document object | |
addTitle.pptx | Insert a title into a pptx object | |
addFooter.pptx | Insert a footer shape into a document pptx object | |
add.plot.interactivity | add interactivity on a plot | |
add.pot | add a paraggraph to an existing set of paragraphs of text | |
addImage.pptx | Insert an external image into a pptx object | |
addPage | Add a page into a document object | |
addParagraph | Add a paragraph into a document object | |
addParagraph.docx | Insert a paragraph into a docx object | |
as.html.FlexTable | get HTML code from a FlexTable | |
cellProperties | Cell formatting properties | |
addImage | Add an external image into a document object | |
addImage.docx | Insert external images into a docx object | |
addParagraph.html | Insert a paragraph into an html object | |
chprop | Change a formatting properties object | |
RScript | RScript object | |
addParagraph.pptx | Insert a paragraph into a pptx object | |
addPage.html | Insert a page into an html object | |
addPostCommand | add post plot commands | |
addRScript.pptx | Add R script into a pptx object | |
addSlide | Add a slide into a document object | |
addPageNumber | Insert a page number into a document object | |
addPageNumber.pptx | Insert a page number shape into a document pptx object | |
addSlide.pptx | Insert a slide into a pptx object | |
addTable.pptx | Insert a table into an pptx object | |
addSubtitle | Add a subtitle shape into a document object | |
addTable.docx | Insert a table into a docx object | |
ReporteRs-package | ReporteRs: a package to create document from R | |
addRScript | Add R script into a document object | |
addTitle | Add a title into a document object | |
addFlexTable | Insert a FlexTable into a document object | |
addFlexTable.docx | Insert a FlexTable into a docx object | |
dim.docx | Get page layout dimensions of a Word document | |
addFooterRow | add footer in a FlexTable | |
addTOC.docx | Insert a table of contents into a docx object | |
addPlot.html | Add a plot into an html object | |
addHeaderRow | add header in a FlexTable | |
addTable.html | Insert a table into an html object | |
addPlot.pptx | Add a plot into a pptx object | |
borderDotted | shortcut for dotted border | |
addTable | Add a table into a document object | |
addRScript.docx | Add R script into a docx object | |
dim.pptx | Get layout information on a PowerPoint slide | |
borderNone | shortcut for no border | |
chprop.cellProperties | Modify a cell formatting properties object | |
as.html.pot | get HTML code from a pot | |
chprop.parProperties | Modify paragraph formatting properties | |
borderProperties | border properties object | |
borderSolid | shortcut for solid border | |
docx-bookmark | docx bookmarks | |
borderDashed | shortcut for dashed border | |
declareTitlesStyles | Set manually headers'styles of a document object | |
declareTitlesStyles.docx | Set manually headers'styles of a docx object | |
docx | Create Microsoft Word document object representation | |
parRight | shortcut for right alignment | |
parCenter | shortcut for centered alignment | |
pbc_summary | pbc summary | |
setFlexTableBorders | change grid lines of a FlexTable | |
addRScript.html | Add R script into a html object | |
setFlexTableWidths | set columns widths of a FlexTable | |
addTitle.docx | Insert a title into a docx object | |
chprop.textProperties | Modify text formatting properties | |
textItalic | shortcut for italic | |
data_ReporteRs | Dummy dataset used in ReporterRs examples | |
parJustify | shortcut for justified alignment | |
print.html | print informations about an object of class "html". | |
print.pptx | print informations about an object of class "pptx". | |
get.darker.tableProperties | get a darker tableProperties | |
textNormal | shortcut for default textProperties | |
get.default.tableProperties | get default tableProperties | |
addTitle.html | Insert a title into a html object | |
as.html.RScript | get HTML code from a RScript object | |
get.greenheader.tableProperties | get a green header tableProperties | |
set_of_paragraphs | Set of paragraphs of text | |
as.html | get HTML code | |
deleteBookmark | delete a bookmark into a docx object | |
toc.options.docx | Set TOC options | |
get.light.tableProperties | get a 'lighter' tableProperties | |
+.pot | pot concatenation | |
parLeft | shortcut for left alignment | |
parProperties | Paragraph formatting properties | |
triggerPostCommand | trigger post plot commands | |
slide.layouts | Get layout names of a document object | |
deleteBookmarkNextContent | delete first content after a bookmark into a docx object | |
html | Create an HTML document object representation | |
slide.layouts.pptx | Get layout names of a pptx document | |
is.color | color checking | |
pot | Piece of Text (formated text) | |
spanFlexTableColumns | Span columns within rows | |
registerRaphaelGraph | register Raphael plots | |
writeDoc.html | Write a html object in a html file | |
pptx | Create Microsoft PowerPoint document object representation | |
setColumnsColors | applies background colors to columns of a FlexTable | |
spanFlexTableRows | Span rows within columns | |
print.docx | print informations about an object of class "docx". | |
styles | Get styles names of a document object | |
setRowsColors | applies background colors to rows of a FlexTable | |
print.textProperties | print formatting properties | |
writeDoc.pptx | Write a pptx object in a pptx file | |
setZebraStyle | FlexTable rows zebra striping | |
writeDoc | Write a document object | |
textBold | shortcut for bold | |
textBoldItalic | shortcut for bold italic | |
writeDoc.docx | Write a docx object in a docx file | |
raphael.html | get HTML code from a plot | |
styles.docx | Get styles names of a docx document | |
tableProperties | Table formatting properties | |
textProperties | Text formatting properties | |
toc.options | Set TOC options for a document object | |
[<-.FlexTable | alter FlexTable content and format | |
addFlexTable.html | Insert a FlexTable into a docx object | |
No Results! |
Details
Type | Package |
Date | 2014-07-24 |
License | GPL-3 |
Copyright | See file COPYRIGHTS. |
SystemRequirements | java (>= 1.6) |
URL | http://davidgohel.github.io/ReporteRs/index.html |
BugReports | https://github.com/davidgohel/ReporteRs/issues |
imports | base64 , rJava |
suggests | ggplot2 |
depends | R (>= 3.0) , ReporteRsjars |
Contributors | David Gohel |
Include our badge in your README
[](http://www.rdocumentation.org/packages/ReporteRs)