tools (version 3.3)

HTMLheader: Generate a standard HTML header for R help

Description

This function generates the standard HTML header used on R help pages.

Usage

HTMLheader(title = "R", logo = TRUE, up = NULL,
           top = file.path(Rhome, "doc/html/index.html"),
           Rhome = "",
           css = file.path(Rhome, "doc/html/R.css"),
           headerTitle = paste("R:", title),
           outputEncoding = "UTF-8")

Arguments

title

The title to display and use in the HTML headers. Should have had any HTML escaping already done.

logo

Whether to display the R

Value

• A character vector containing the lines of an HTML header which can be used to start a page in the R help system.

item

• up
• top
• Rhome
• css
• headerTitle
• outputEncoding

dQuote

• up
• top

bold

relative

sQuote

Details

Details

The up and top links should be relative to the current page. The Rhome path default works with dynamic help; for static help, a relative path (e.g., ../..) to it should be used.

Examples

cat(HTMLheader("This is a sample header"), sep="")