一些R
包他們的幫助/文檔和鏈接到那些部分酒吧中(例如,ggplot2
,dplyr
,devtools
等)已按字母順序有權段(由下圖紅色箭頭所示)。其他包(例如,RcmdrMisc
)沒有。添加章節至R包的幫助/文檔
如何將這些元素添加到可能的R
軟件包的幫助中?
我用roxygen2
的文檔。
一些R
包他們的幫助/文檔和鏈接到那些部分酒吧中(例如,ggplot2
,dplyr
,devtools
等)已按字母順序有權段(由下圖紅色箭頭所示)。其他包(例如,RcmdrMisc
)沒有。添加章節至R包的幫助/文檔
如何將這些元素添加到可能的R
軟件包的幫助中?
我用roxygen2
的文檔。
在寫作R附加文件(包括從CRAN R的每個副本)是與INDEX文件的一小部分:
1.1.4索引文件
可選的文件索引包含一個爲包中每個足夠感興趣的對象提供一行,並給出它的名稱和描述(通常不會顯式調用打印方法等功能)。通常,該文件丟失,並且從源文件安裝時會自動從文檔來源生成相應的信息(使用
tools::Rdindex()
)。
當包有索引文件時,HTML代碼位於html
文件夾中。
我發現'我的軟件包的安裝版本中的'html'文件夾,但我仍然不明白,如何使部分。函數'tools :: Rdindex()'負責在安裝包的過程中使用索引創建HTML文件? – Vilmantas
這是我對通常過程的理解。自動魔法。 –
好問題!我想這些軟件包的源代碼可以給出一個答案(如果沒有人知道它的話)。 –
據我所知,這些索引文件是自動生成的。至少,我的軟件包總是有它們,但我從來沒有寫過它們。我一直認爲這些字母會自動添加,一旦函數列表變得足夠長。但我可能是錯的。 – Stibu
我在GitHub上研究了幾個包的結構,但沒有找到如何製作這個按字母順序排列的索引。 – Vilmantas