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