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