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