ReporteRs v0.5
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.
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")
if( !require( highlight ) ) install.packages("highlight")
From sources
From an R console (R >= 3.0):
if( !require( devtools ) ) install.packages("devtools")
devtools::install_github('ReporteRsjars', 'davidgohel')
devtools::install_github('ReporteRs', 'davidgohel')
Binary package
Packages are available here:
https://github.com/davidgohel/ReporteRsjars/releases/tag/v0.1 https://github.com/davidgohel/ReporteRs/releases/tag/v0.4
Getting Started
Help: http://davidgohel.github.io/ReporteRs/index.html
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 | |
addTable | Add a table into a document object | |
addFlexTable.html | Insert a FlexTable into a docx object | |
addDate.pptx | Insert a date shape into a document pptx object | |
ParagraphSection | ParagraphSection (internal use only) | |
FlexTable | FlexTable | |
[<-.FlexTable | Format FlexTable content | |
addFlexTable.pptx | Insert a FlexTable into a docx object | |
addFlexCellContent | Add content in a FlexTable | |
addTable.docx | Insert a table into a docx object | |
addFlexTable.docx | Insert a FlexTable into a docx object | |
addImage.html | Insert an external image into a html object | |
addImage.pptx | Insert an external image into a pptx object | |
ReporteRs-package | ReporteRs: a package to create document from R | |
addFooter | Insert a footer into a document object | |
addPlot.pptx | Add a plot into a pptx object | |
addSlide | Add a slide into a document object | |
addImage.docx | Insert external images into a docx object | |
add.pot | add a paraggraph to an existing set of paragraphs of text | |
addDate | Insert a date into a document object | |
addFooterRow | add footer in a FlexTable | |
addParagraph | Add a paragraph into a document object | |
FontMetric | Font metric | |
Paragraph | Paragraph (internal use only) | |
addPage | Add a page into a document object | |
addHeaderRow | add header in a FlexTable | |
FlexRow | Row object for FlexTable | |
addParagraph.docx | Insert a paragraph into a docx object | |
addImage | Add an external image into a document object | |
cellProperties | Cell formating properties | |
print.docx | print informations about an object of class "docx". | |
addPlot | Add a plot into a document object | |
addPageNumber | Insert a page number into a document object | |
print.pptx | print informations about an object of class "pptx". | |
data_ReporteRs | Dummy dataset used in ReporterRs examples | |
FlexCell | Cell object for FlexTable | |
get.default.tableProperties | get default tableProperties | |
addFooter.pptx | Insert a footer shape into a document pptx object | |
gforge_datacopy | melanoma dataset from boot package | |
declareTitlesStyles | Set manually headers'styles of a document object | |
addPageBreak | Add a page break into a document object | |
addPageBreak.docx | Insert a page break into a docx object | |
addFlexTable | Insert a FlexTable into a document object | |
addPage.html | Insert a page into an html object | |
get.light.tableProperties | get a 'lighter' tableProperties | |
addPlot.html | Add a plot into an html object | |
addRScript | Add R script into a document object | |
addTable.html | Insert a table into an html object | |
addPageNumber.pptx | Insert a page number shape into a document pptx object | |
addSubtitle | Add a subtitle shape into a document object | |
addTOC | Add a table of contents into a document object | |
addPlot.docx | Add a plot into a docx object | |
addTitle | Add a title into a document object | |
addRScript.html | Add R script into a html object | |
addTOC.docx | Insert a table of contents into a docx object | |
print.textProperties | print formating properties | |
addParagraph.pptx | Insert a paragraph into a pptx object | |
get.greenheader.tableProperties | get a green header tableProperties | |
addParagraph.html | Insert a paragraph into an html object | |
textProperties | Text formating properties | |
declareTitlesStyles.docx | Set manually headers'styles of a docx object | |
slide.layouts.pptx | Get layout names of a pptx document | |
addSlide.pptx | Insert a slide into a pptx object | |
+.pot | pot concatenation | |
deleteBookmarkNextContent | delete first content after a bookmark into a docx object | |
styles | Get styles names of a document object | |
html | Create an HTML document object representation | |
addSubtitle.pptx | Insert a addSubtitle shape into a pptx object | |
addTitle.docx | Insert a title into a docx object | |
parProperties | Paragraph formating properties | |
get.darker.tableProperties | get a darker tableProperties | |
addTable.pptx | Insert a table into an pptx object | |
writeDoc.html | Write a html object in a html file | |
addTitle.html | Insert a title into a html object | |
pot | Piece of Text (formated text) | |
addTitle.pptx | Insert a title into a pptx object | |
print.html | print informations about an object of class "html". | |
deleteBookmark | delete a bookmark into a docx object | |
writeDoc | Write a document object | |
pptx | Create Microsoft PowerPoint document object representation | |
writeDoc.docx | Write a docx object in a docx file | |
docx | Create Microsoft Word document object representation | |
writeDoc.pptx | Write a pptx object in a pptx file | |
registerRaphaelGraph | register Raphael plots | |
is.color | color checking | |
set_of_paragraphs | Set of paragraphs of text | |
slide.layouts | Get layout names of a document object | |
styles.docx | Get styles names of a docx document | |
setFlexCellContent | Replace FlexTable content | |
tableProperties | Table formating properties | |
No Results! |
Details
Type | Package |
Date | 2014-04-10 |
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 |
Collate | '00_AllGeneric.R' '01_tools.R' 'addDate.pptx.R' 'addFlexTable.docx.R' 'addFlexTable.html.R' 'addFlexTable.pptx.R' 'addFooter.pptx.R' 'addImage.docx.R' 'addImage.html.R' 'addImage.pptx.R' 'addPage.html.R' 'addPageBreak.docx.R' 'addPageNumber.pptx.R' 'addParagraph.docx.R' 'addParagraph.html.R' 'addParagraph.pptx.R' 'addPlot.docx.R' 'addPlot.html.R' 'addPlot.pptx.R' 'addRScript.html.R' 'addSlide.pptx.R' 'addSubtitle.pptx.R' 'addTable.docx.R' 'addTable.html.R' 'addTable.pptx.R' 'addTitle.docx.R' 'addTitle.html.R' 'addTitle.pptx.R' 'addTOC.docx.R' 'bootstrap.copy.R' 'cellProperties.R' 'deleteBookmark.R' 'docx.R' 'drawingML.R' 'FlexCell.R' 'FlexRow.R' 'FlexTable.R' 'FontMetric.R' 'html.R' 'is.color.R' 'java_description.R' 'Paragraph.R' 'ParagraphSection.R' 'parProperties.R' 'pot.R' 'pptx.R' 'print.docx.R' 'print.html.R' 'print.pptx.R' 'ReporteRs.R' 'set_of_pot.R' 'setHeaderStyle.docx.R' 'slide.layouts.pptx.R' 'styles.docx.R' 'tableProperties.R' 'textProperties.R' 'themes.tableProperties.R' 'writeDoc.docx.R' 'writeDoc.html.R' 'writeDoc.pptx.R' |
imports | base64 , highlight , rJava |
suggests | ggplot2 |
depends | R (>= 3.0) , ReporteRsjars |
Contributors | David Gohel |
Include our badge in your README
[](http://www.rdocumentation.org/packages/ReporteRs)