printComment.HtmlPrintStream: Prints a HTML comment

Description Usage Arguments Value Author(s)

Description

Prints a HTML comment to the connected output stream. Note that it is not safe nor correct to use two consequtive dashes (--) in the comment. If the comment contains such insafe characters and onError is NULL an error will be thrown.

Usage

1
2
## S3 method for class 'HtmlPrintStream'
printComment(this, ..., sep="", collapse=" ", indent=FALSE, onError=NULL)

Arguments

...

one or more R objects, to be coerced to character vectors.

sep

A character string to separate the terms. Default value is "" (note the difference from paste() and cat().

collapse

A character string to separate the results. Default value is "" (note the difference from paste() and cat().

indent

If TRUE, the comment will be indented, otherwise not. Default value is FALSE.

onError

A function that accepts the final comment string as a first argument and returns a modified comment string. If NULL, an internal error function will be used. Default value is NULL.

Value

Returns nothing.

Author(s)

Henrik Bengtsson (http://www.braju.com/R/)


HenrikBengtsson/R.io documentation built on May 6, 2019, 11:54 p.m.