将 R 包文档导出到网页

Question

我按照 Hadley Wickham 关于如何使用 Roxygen 构建和记录包的说明创建了一个 R 包。现在我想将函数帮助页面和插图导出到一堆 html 文件中，以便也可以在网站上阅读和链接到它。

当我在我的库中查找已安装的软件包时，有一个 html 文件夹，但它只包含一个

00Index.html

 页面。有没有一种简单的方法可以导出我的包文档的其余部分（功能帮助页面和小插图）？

Answer 1

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

staticdocs。

或者，如果您有渲染的 Rd 文件，您可以使用 R 附带的

tools

 包中的实用函数 

Rd2HTML 将每个文件转换为 HTML。使用 ?tools::Rd2HTML 阅读更多相关信息

Answer 2

稍微修改了

Yihui Xie的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") 每次构建包时，您都需要重新运行此函数。

Answer 3

pkgdown 的新替代品是

Altdoc，它是一个简单而强大的包，用于为 R 包创建文档网站。它允许您使用许多框架输出文档，包括 Quarto 网站。