将 R 包文档导出到网页

Question

我在 Hadley Wickham's instruction on how to build and document packages with Roxygen 之后创建了一个 R 包。现在我想将功能帮助页面和插图导出到一堆 html 文件中，以便它也可以在网站上阅读和链接。

当我在我的库中查看已安装包时，有一个 html 文件夹，但它只包含一个 00Index.html 页面。有没有一种简单的方法可以导出我的包文档的其余部分（功能帮助页面和插图）？

Answer 1

您可以使用 Hadley Wickham 的开发中（即不在 CRAN 上）包 staticdocs。

或者，如果您有渲染的 Rd 文件，您可以使用随附的工具包中的实用函数 Rd2HTML 将每个文件转换为 HTML使用 R。使用 ?tools::Rd2HTML

了解更多信息

Answer 2

对 Yihui Xie's function to Build Static HTML Help Pages for R Packages 稍作修改，以便在包的 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
}

将它用于开发中的包：

static_help("my_package_name")

每次构建包时都需要重新运行此函数。

将 R 包文档导出到网页

Export R package documentation to a web page

r

package