ReporteRs (version 0.5.2)

addPlot.docx: Add a plot into a docx object

Description

Add a plot into the docx object.

Usage

# S3 method for docx
addPlot(doc, fun, pointsize = getOption("ReporteRs-fontsize"),
  vector.graphic = F, width = 6, height = 6,
  fontname = getOption("ReporteRs-default-font"), editable = TRUE, bookmark,
  parStyle = parProperties(text.align = "center", padding = 5), ...)

Arguments

doc

the docx to use

fun

plot function

width

plot width in inches (default value is 6).

height

plot height in inches (default value is 6).

vector.graphic

logical scalar, default to FALSE.

DrawingML instructions cannot be read by MS Word 2007.

bookmark

id of the Word bookmark to replace by the plot. optional.

bookmark is a character vector specifying bookmark id to replace by the plot(s). If provided, plot(s) will replace the paragraph that contains the bookmark. If not provided, plot(s) will be added at the end of the document.

parStyle

paragraph formatting properties of the paragraph that contains plot(s). An object of class parProperties

pointsize

the default pointsize of plotted text in pixels, default to getOption("ReporteRs-fontsize").

fontname

the default font family to use, default to getOption("ReporteRs-default-font").

editable

logical value - if TRUE vector graphics elements (points, texts, etc.) are editable.

...

arguments for fun.

Value

an object of class "docx".

See Also

docx, addPlot

Examples

# NOT RUN {
#START_TAG_TEST
require( ggplot2 )

# Create a new document
doc = docx( title = "title" )

doc = addTitle( doc, "Plot 1", level = 1 )
# Add a base plot - set vector.graphic to FALSE if Word version
# used to read the file is <= 2007
doc = addPlot( doc, fun = plot
		, x = rnorm( 100 )
		, y = rnorm (100 )
		, main = "base plot main title"
		, vector.graphic = TRUE
		, width = 5, height = 7
		, parStyle = parProperties(text.align = "left")
	)

doc = addTitle( doc, "Plot 2", level = 1 )
myplot = qplot(Sepal.Length, Petal.Length, data = iris, color = Species
	, size = Petal.Width, alpha = I(0.7))
doc = addPlot( doc = doc
		, fun = print
		, x = myplot #this argument MUST be named, print is expecting argument 'x'
	)

# Write the object in file "addPlot_example.docx"
writeDoc( doc, "addPlot_example.docx" )
#STOP_TAG_TEST
# }