ReporteRs v0.5.7
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 | |
addTOC.docx | Insert a table of contents into a docx object | |
ReporteRs-package | ReporteRs: a package to create document from R | |
addFooter.pptx | Insert a footer shape into a document pptx object | |
addPageNumber | Insert a page number into a document object | |
addFlexTable.pptx | Insert a FlexTable into a pptx object | |
addFooterRow | add footer in a FlexTable | |
add.plot.interactivity | add interactivity on a plot | |
deleteBookmark | delete a bookmark into a docx object | |
[<-.FlexTable | modify FlexTable content | |
addPageBreak.docx | Insert a page break into a docx object | |
addPlot.pptx | Add a plot into a pptx object | |
addImage.docx | Insert external images into a docx object | |
setColumnsColors | applies background colors to columns of a FlexTable | |
styles | Get styles names of a document object | |
addPostCommand | add post plot commands | |
addSlide | Add a slide into a document object | |
addTable | Add a table into a document object | |
html | Create an HTML document object representation | |
addSubtitle | Add a subtitle shape into a document object | |
addFlexTable.docx | Insert a FlexTable into a docx object | |
addDate | Insert a date into a document object | |
FlexTable | FlexTable creation | |
set_of_paragraphs | Set of paragraphs of text | |
addSlide.pptx | Insert a slide into a pptx object | |
addHeaderRow | add header in a FlexTable | |
addImage.pptx | Insert an external image into a pptx object | |
add.pot | add a paraggraph to an existing set of paragraphs of text | |
FlexRow | Row object for FlexTable | |
addTable.docx | Insert a table into a docx object | |
addRScript.pptx | Add R script into a pptx object | |
addRScript.html | Add R script into a html object | |
addImage.html | Insert an external image into a html object | |
addFlexTable.html | Insert a FlexTable into a docx object | |
borderDashed | shortcut for dashed border | |
addPlot.docx | Add a plot into a docx object | |
Paragraph | Paragraph (internal use only) | |
chprop.parProperties | Modify paragraph formatting properties | |
FontMetric | Font metric | |
addPlot.html | Add a plot into an html object | |
docx | Create Microsoft Word document object representation | |
as.html.FlexTable | get HTML code from a FlexTable | |
as.html | get HTML code | |
addDate.pptx | Insert a date shape into a document pptx object | |
borderDotted | shortcut for dotted border | |
spanFlexTableColumns | Span columns within rows | |
addPageNumber.pptx | Insert a page number shape into a document pptx object | |
addPlot | Add a plot into a document object | |
ParagraphSection | ParagraphSection (internal use only) | |
chprop.textProperties | Modify text formatting properties | |
data_ReporteRs | Dummy dataset used in ReporterRs examples | |
addTitle.html | Insert a title into a html object | |
declareTitlesStyles.docx | Set manually headers'styles of a docx object | |
addTOC | Add a table of contents into a document object | |
addPage | Add a page into a document object | |
addParagraph | Add a paragraph into a document object | |
textNormal | shortcut for default textProperties | |
pot | Piece of Text (formated text) | |
parJustify | shortcut for justified alignment | |
addTitle.pptx | Insert a title into a pptx object | |
chprop | Change a formatting properties object | |
parLeft | shortcut for left alignment | |
pptx | Create Microsoft PowerPoint document object representation | |
cellProperties | Cell formatting properties | |
[<-.FlexRow | modify FlexRow content | |
get.default.tableProperties | get default tableProperties | |
setFlexTableBorders | change grid lines of a FlexTable | |
borderSolid | shortcut for solid border | |
dim.pptx | Get layout information on a PowerPoint slide | |
get.darker.tableProperties | get a darker tableProperties | |
get.light.tableProperties | get a 'lighter' tableProperties | |
styles.docx | Get styles names of a docx document | |
addFlexTable | Insert a FlexTable into a document object | |
raphael.html | Add a plot into an html object | |
registerRaphaelGraph | register Raphael plots | |
+.pot | pot concatenation | |
spanFlexTableRows | Span rows within columns | |
FlexCell | Cell object for FlexTable | |
tableProperties | Table formatting properties | |
textBold | shortcut for bold | |
print.textProperties | print formatting properties | |
addFooter | Insert a footer into a document object | |
addPage.html | Insert a page into an html object | |
addParagraph.docx | Insert a paragraph into a docx object | |
slide.layouts | Get layout names of a document object | |
addTable.html | Insert a table into an html object | |
addImage | Add an external image into a document object | |
addParagraph.pptx | Insert a paragraph into a pptx object | |
addPageBreak | Add a page break into a document object | |
chprop.cellProperties | Modify a cell formatting properties object | |
parProperties | Paragraph formatting properties | |
addTitle.docx | Insert a title into a docx object | |
addSubtitle.pptx | Insert a addSubtitle shape into a pptx object | |
addParagraph.html | Insert a paragraph into an html object | |
deleteBookmarkNextContent | delete first content after a bookmark into a docx object | |
addTitle | Add a title into a document object | |
borderNone | shortcut for no border | |
addRScript | Add R script into a document object | |
docx-bookmark | docx bookmarks | |
pbc_summary | pbc summary | |
get.greenheader.tableProperties | get a green header tableProperties | |
addRScript.docx | Add R script into a docx object | |
addTable.pptx | Insert a table into an pptx object | |
print.html | print informations about an object of class "html". | |
dim.docx | Get page layout dimensions of a Word document | |
is.color | color checking | |
writeDoc.pptx | Write a pptx object in a pptx file | |
print.pptx | print informations about an object of class "pptx". | |
setZebraStyle | FlexTable rows zebra striping | |
declareTitlesStyles | Set manually headers'styles of a document object | |
borderProperties | border properties object | |
textProperties | Text formatting properties | |
parCenter | shortcut for centered alignment | |
setFlexTableWidths | set columns widths of a FlexTable | |
print.docx | print informations about an object of class "docx". | |
slide.layouts.pptx | Get layout names of a pptx document | |
parRight | shortcut for right alignment | |
writeDoc.docx | Write a docx object in a docx file | |
setRowsColors | applies background colors to rows of a FlexTable | |
triggerPostCommand | trigger post plot commands | |
textBoldItalic | shortcut for bold italic | |
writeDoc | Write a document object | |
textItalic | shortcut for italic | |
writeDoc.html | Write a html object in a html file | |
No Results! |
Details
Type | Package |
Date | 2014-06-04 |
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)