hwriteImage {hwriter}R Documentation

Insert an HTML image

Description

Inserts an image in an HTML document. The image can be either an external one specified by an URL or can be captured from the current graphic device.

Usage

hwriteImage(image.url, page=NULL, image.border=0, width=NULL,
height=NULL, capture=FALSE, ...)

Arguments

image.url a character string containing the URL of an image, which can be also a path to a local filename.
page an optional connection, a character string naming the file to write to or a page object returned by openPage.
image.border an optional numeric value specifiying the width of the image border. Default is 0.
width, height an optional HTML length unit (in pixels) specifiying the width (resp. height) at which the image should be rendered. If missing, the default image width (resp. height) will be used.
capture a logical. If TRUE the image from the current graphic device is captured and written as a PNG file to the filename specified by image.url. Capture resolution is controlled by width and height, which have a default value of 400 pixels. Default is FALSE.
... optional arguments that will be dispatched to the underlying hwrite call.

Details

hwriteImage constructs an HTML <img> tag to insert a image. This function can be seamlessly in conjuction with hwrite to position an image. The capture argument enables to capture easily a current plot and to insert it in a web page.

Value

A character string containing the output HTML code.

Author(s)

Gregoire Pau, gpau@ebi.ac.uk, 2008

See Also

hwrite.

Examples

## Creates a new web page 'test.html'
p <- openPage('test.html')

## Insert an external image
img=hwriteImage('http://www.ebi.ac.uk/~gpau/hwriter/iris1.jpg', center=TRUE)
hwrite(c(img,caption='Iris'), p, dim=c(2,1),
row.style=list(caption='text-align:center;background-color:#fac'),
row.names=FALSE, br=TRUE)

## Closes the web page
closePage(p)

## Opens a web browser to see the result
browseURL('test.html')

[Package hwriter version 0.91 Index]