R HTMLheader 为 R 帮助生成标准 HTML 标头

说明

此函数生成 R 帮助页面上使用的标准 HTML 标头。

用法

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")

参数

title	在 HTML 标头中显示和使用的标题。应该已经完成了任何 HTML 转义。
logo	是否显示R标题后的徽标。
up	“up” 按钮上链接到哪个页面(如果有)。
top	“top” 按钮上链接到哪个页面(如果有)。
Rhome	R 主目录的相对路径。请参阅“详细信息”。
css	级联样式表的相对 URL。
headerTitle	标题中使用的标题。
outputEncoding	整个页面声明的编码。

细节

up和top链接应该是相对于当前页面的。这Rhome路径默认与动态帮助一起使用；对于静态帮助，相对路径(例如，‘../..’)应该使用它。

值

包含 HTML 标头行的字符向量，可用于在 R 帮助系统中启动页面。

例子

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