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文件，则可以使用R附带的工具包中的实用程序函数Rd2HTML将每个文件转换为HTML。使用{了解更多相关信息{1}}

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包文档导出到网页

2 个答案: