ReporteRs v0.1

Readme

ReporteRs

ReporteRs is a R package for creating MS Word documents, MS PowerPoint documents and HTML documents from R.

Features

Create docx, pptx or html files with only a few lines of R code.
Add tables, plots, texts, etc.
Simple R functions are available for customizing formatting properties of R output.

Installation

From an R console (R >= 3.0):

install.packages("devtools")
devtools::install_github('ReporteRs', 'davidgohel')

Dependencies

R packages : rJava, ggplot2, base64, highlight
Java (it has been tested with java version >= 1.6)

Getting Started

library(ReporteRs)
example(docx) #run a complete and detailed docx example
example(pptx) #run a complete and detailed docx example
example(html) #run a complete and detailed docx example

?ReporteRs
?addTable
?addPlot
?addParagraph
?docx
?pptx
?html

License

The ReporteRs package is licensed under the GPLv3.

Functions in ReporteRs

Name	Description
writeDoc.pptx	Write a pptx object in a pptx file
add.pot	add a paraggraph to an existing set of paragraphs of text
addTOC.docx	Insert a table of contents into a docx object
addSlide.pptx	Insert a slide into a pptx object
addPage	Add a page into a document object
addImage.docx	Insert external images into a docx object
addParagraph.docx	Insert a paragraph into a docx object
addTitle	Add a title into a document object
addPlot.pptx	Add a plot into a pptx object
addImage.pptx	Insert an external image into a pptx object
writeDoc.docx	Write a docx object in a docx file
addParagraph.pptx	Insert a paragraph into a pptx object
addDate	Insert a date into a document object
addTable.pptx	Insert a table into an pptx object
get.light.tableProperties	get a 'lighter' tableProperties
addParagraph.html	Insert a paragraph into an html object
addImage.html	Insert an external image into a html object
addSubtitle.pptx	Insert a addSubtitle shape into a pptx object
docx	Create Microsoft Word document object representation
addDate.pptx	Insert a date shape into a document pptx object
addPageBreak.docx	Insert a page break into a docx object
get.greenheader.tableProperties	get a green header tableProperties
addFooter	Insert a footer into a document object
slide.layouts	Get layout names of a document object
declareTitlesStyles.docx	Set manually headers'styles of a docx object
addPlot	Add a plot into a document object
addPageNumber	Insert a page number into a document object
addSubtitle	Add a subtitle shape into a document object
addRScript	Add R script into a document object
html	Create an HTML document object representation
slide.layouts.pptx	Get layout names of a pptx document
writeDoc	Write a document object
is.color	color checking
addTOC	Add a table of contents into a document object
print.pptx	print informations about an object of class "pptx".
print.textProperties	print formating properties
pot	Piece of Text (formated text)
parProperties	Paragraph formating properties
+.pot	pot concatenation
print.docx	print informations about an object of class "docx".
addTable	Add a table into a document object
addTitle.pptx	Insert a title into a pptx object
cellProperties	Cell formating properties
FontMetric	Font metric
styles.docx	Get styles names of a docx document
styles	Get styles names of a document object
writeDoc.html	Write a html object in a html file
addFooter.pptx	Insert a footer shape into a document pptx object
addPageNumber.pptx	Insert a page number shape into a document pptx object
addPlot.docx	Add a plot into a docx object
addImage	Add an external image into a document object
addPage.html	Insert a page into an html object
addTable.html	Insert a table into an html object
addParagraph	Add a paragraph into a document object
addTable.docx	Insert a table into a docx object
addPageBreak	Add a page break into a document object
addTitle.docx	Insert a title into a docx object
addPlot.html	Add a plot into an html object
ReporteRs-package	ReporteRs: a package to create document from R
tableProperties	Table formating properties
addTitle.html	Insert a title into a html object
get.default.tableProperties	get default tableProperties
addRScript.html	Add R script into a html object
addSlide	Add a slide into a document object
data_ReporteRs	Dummy dataset used in ReporterRs examples
declareTitlesStyles	Set manually headers'styles of a document object
registerRaphaelGraph	register Raphael plots
get.darker.tableProperties	get a darker tableProperties
pptx	Create Microsoft PowerPoint document object representation
set_of_paragraphs	Set of paragraphs of text
textProperties	Text formating properties
print.html	print informations about an object of class "html".
No Results!

Name

Description

writeDoc.pptx

Write a pptx object in a pptx file

add.pot

add a paraggraph to an existing set of paragraphs of text

addTOC.docx

Insert a table of contents into a docx object

addSlide.pptx

Insert a slide into a pptx object

addPage

Add a page into a document object

addImage.docx

Insert external images into a docx object

addParagraph.docx

Insert a paragraph into a docx object

addTitle

Add a title into a document object

addPlot.pptx

Add a plot into a pptx object

addImage.pptx

Insert an external image into a pptx object

writeDoc.docx

Write a docx object in a docx file

addParagraph.pptx

Insert a paragraph into a pptx object

addDate

Insert a date into a document object

addTable.pptx

Insert a table into an pptx object

get.light.tableProperties

get a 'lighter' tableProperties

addParagraph.html

Insert a paragraph into an html object

addImage.html

Insert an external image into a html object

addSubtitle.pptx

Insert a addSubtitle shape into a pptx object

docx

Create Microsoft Word document object representation

addDate.pptx

Insert a date shape into a document pptx object

addPageBreak.docx

Insert a page break into a docx object

get.greenheader.tableProperties

get a green header tableProperties

addFooter

Insert a footer into a document object

slide.layouts

Get layout names of a document object

declareTitlesStyles.docx

Set manually headers'styles of a docx object

addPlot

Add a plot into a document object

addPageNumber

Insert a page number into a document object

addSubtitle

Add a subtitle shape into a document object

addRScript

Add R script into a document object

html

Create an HTML document object representation

slide.layouts.pptx

Get layout names of a pptx document

writeDoc

Write a document object

is.color

color checking

addTOC

Add a table of contents into a document object

print.pptx

print informations about an object of class "pptx".

print.textProperties

print formating properties

pot

Piece of Text (formated text)

parProperties

Paragraph formating properties

+.pot

pot concatenation

print.docx

print informations about an object of class "docx".

addTable

Add a table into a document object

addTitle.pptx

Insert a title into a pptx object

cellProperties

Cell formating properties

FontMetric

Font metric

styles.docx

Get styles names of a docx document

styles

Get styles names of a document object

writeDoc.html

Write a html object in a html file

addFooter.pptx

Insert a footer shape into a document pptx object

addPageNumber.pptx

Insert a page number shape into a document pptx object

addPlot.docx

Add a plot into a docx object

addImage

Add an external image into a document object

addPage.html

Insert a page into an html object

addTable.html

Insert a table into an html object

addParagraph

Add a paragraph into a document object

addTable.docx

Insert a table into a docx object

addPageBreak

Add a page break into a document object

addTitle.docx

Insert a title into a docx object

addPlot.html

Add a plot into an html object

ReporteRs-package

ReporteRs: a package to create document from R

tableProperties

Table formating properties

addTitle.html

Insert a title into a html object

get.default.tableProperties

get default tableProperties

addRScript.html

Add R script into a html object

addSlide

Add a slide into a document object

data_ReporteRs

Dummy dataset used in ReporterRs examples

declareTitlesStyles

Set manually headers'styles of a document object

registerRaphaelGraph

get.darker.tableProperties

get a darker tableProperties

pptx

Create Microsoft PowerPoint document object representation

set_of_paragraphs

Set of paragraphs of text

textProperties

Text formating properties

print.html

print informations about an object of class "html".

No Results!

Details

Type	Package
Date	2014-01-02
License	GPL-3
URL	www.nourlyet.org
Collate	'docx.R' 'print.docx.R' 'addPageBreak.docx.R' '00_AllGeneric.R' '01_tools.R' 'addImage.docx.R' 'addParagraph.docx.R' 'addPlot.docx.R' 'addTable.docx.R' 'addTOC.docx.R' 'setHeaderStyle.docx.R' 'styles.docx.R' 'writeDoc.docx.R' 'pptx.R' 'writeDoc.pptx.R' 'addTable.pptx.R' 'addPlot.pptx.R' 'addImage.pptx.R' 'addParagraph.pptx.R' 'print.pptx.R' 'addDate.pptx.R' 'addPageNumber.pptx.R' 'addFooter.pptx.R' 'addSlide.pptx.R' 'textProperties.R' 'parProperties.R' 'cellProperties.R' 'tableProperties.R' 'is.color.R' 'pot.R' 'addSubtitle.pptx.R' 'set_of_pot.R' 'addTitle.html.R' 'html.R' 'writeDoc.html.R' 'addTable.html.R' 'addPlot.html.R' 'addParagraph.html.R' 'bootstrap.copy.R' 'drawingML.R' 'FontMetric.R' 'addImage.html.R' 'addRScript.html.R' 'addPage.html.R' 'addTitle.docx.R' 'addTitle.pptx.R' 'print.html.R' 'slide.layouts.pptx.R' 'ReporteRs.R' 'themes.tableProperties.R'

imports	base64 , highlight
depends	ggplot2 , R (>= 3.0) , rJava
Contributors	David Gohel