将R包文档导出到网页
我已经创建了一个R包如下。现在,我想将函数帮助页面和vignettes导出到一组html文件中,这样它也可以在网站上读取和链接将R包文档导出到网页,r,package,R,Package,我已经创建了一个R包如下。现在,我想将函数帮助页面和vignettes导出到一组html文件中,这样它也可以在网站上读取和链接 当我在我的库中查找已安装的软件包时,有一个html文件夹,但它只包含一个00Index.html页面。是否有一种简单的方法可以导出我的软件包文档的其余部分(功能帮助页和小插曲)?您可以使用Hadley Wickham的开发中(即不在CRAN上)软件包 或者,如果您有呈现的Rd文件,您可以使用R随附的tools包中的实用功能Rd2HTML将每个文件转换为HTML。使用?t
当我在我的库中查找已安装的软件包时,有一个html文件夹,但它只包含一个
00Index.html
页面。是否有一种简单的方法可以导出我的软件包文档的其余部分(功能帮助页和小插曲)?您可以使用Hadley Wickham的开发中(即不在CRAN上)软件包
或者,如果您有呈现的Rd文件,您可以使用R随附的tools包中的实用功能Rd2HTML
将每个文件转换为HTML。使用?tools::Rd2HTML
稍微修改一下,可以在包的HTML目录中创建静态页面
static_help = function(pkg, links = tools::findHTMLlinks()) {
wd <- getwd()
helpdir <- system.file('html', package = "tradeflows")
setwd(helpdir)
message("Generated help files will be placed in ", helpdir)
pkgRdDB = tools:::fetchRdDB(file.path(find.package(pkg),
'help', pkg))
force(links); topics = names(pkgRdDB)
for (p in topics) {
tools::Rd2HTML(pkgRdDB[[p]],
paste(p, 'html', sep = '.'),
package = pkg,
Links = links,
no_links = is.null(links))
}
setwd(wd) # Get back to the current working directory
}
每次构建软件包时,您都需要重新运行此函数。希望将渐晕图呈现为什么格式以包含在软件包中?渐晕图最好是pdf格式,因为绘图占用的空间稍小,但两者都很好。我知道如何将渐晕图导出为pdf和html格式。我的问题是关于将函数文档导出到html文件的更多内容。感谢将我的
tradeflows::addregion
函数文档导出到html文件的说明,我可以使用Rd2HTML(Rd=“man/addregion.Rd”,out=“/tmp/addregion.html”,package=“tradeflows”)
但在生成的文件底部没有指向包的链接。有没有办法让这成为一个链接。我将检查staticdocs包。使用函数名Rd2HTML
作为搜索关键字,我找到了生成静态文档的链接。正如一条注释所指出的,将工作目录更改为system.file('html',package=“my\u package\u name”)
有助于在正确的位置生成静态html文件。
static_help("my_package_name")