ReporteRs (version 0.7.7)

addImage.bsdoc: Insert an external image into a bsdoc object

Description

Add an external image into a bsdoc object.

Usage

## S3 method for class 'bsdoc':
addImage(doc, filename, width, height,
  par.properties = parProperties(text.align = "center", padding = 5),
  ppi = 72, ...)

Arguments

doc

bsdoc object where external image has to be added

filename

"character" value, complete filename of the external image

width

image width in inches

height

image height in inches

par.properties

paragraph formatting properties of the paragraph that contains images. An object of class parProperties

ppi

dot per inches, default to 72

...

further arguments, not used.

Value

• an object of class bsdoc.

Details

If arguments width and height are missing, values will be defined as their respective number of pixels divide by ppi.

See Also

bsdoc, addPlot.bsdoc , addImage

Examples

doc.filename = "addImage_bsdoc/example.html"

# set default font size to 11
options( "ReporteRs-fontsize" = 11 )

doc = bsdoc( )
# files 'logo.jpg' and 'logosm.jpg' only exist in R for Windows
img.file1 = file.path( Sys.getenv("R_HOME"), "doc", "html", "logo.jpg" )
img.file2 = file.path( Sys.getenv("R_HOME"), "doc", "html", "logosm.jpg" )

if( file.exists( img.file1 ) && file.exists( img.file2 ) ){
  doc = addTitle( doc, "Add images with defaut PPI (72)", level = 1)
  doc = addTitle( doc, "Image 1", level = 2)
  doc = addImage(doc, img.file1 )
  doc = addTitle( doc, "Image 2", level = 2)
  doc = addImage(doc, img.file2 )
  doc = addTitle( doc, "Add images with their respective PPI", level = 1)
  doc = addTitle( doc, "Image 1", level = 2)
  doc = addImage(doc, img.file1, ppi = 300 )
  doc = addTitle( doc, "Image 2", level = 2)
  doc = addImage(doc, img.file2, ppi = 96)
  doc = addTitle( doc, "Add images with width and height", level = 1)
  doc = addImage(doc, img.file1, width = 4, height = 2 )
}

# Write the object
writeDoc( doc, file = doc.filename )