5

staticdocs是一个 Hadley Wickham 包，可以为一个包制作漂亮的网页。我使用它取得了巨大的成功（虽然还没有弄清楚如何添加示例而不出错）但是每次我必须手动重新格式化所index.html创建文件的自述文件部分。这似乎很愚蠢，因为从ggplot2 staticdocs 使用来看，有一种方法可以在inst/staticdocs/.

现在 Hadley 还没有很好地记录包（静态文档），我不确定如何更改索引文件中的自述参数/列表条目。有没有人对这个格式应该是什么样子有指导？即，条目的格式应该如何？

4

1 回答 1

1

在 Hadley 和他的团队能够开发 staticdocs 及其文档之前，我在一个非常粗糙的包中找到了更多的工作：

#' Change read.me File
#'
#' Alter the read.me file with a preset.
#' 
#' @param path Path to the index.html file.
#' @param readme Path to the readme file.
#' @param file The path/file name to output.
readme_statdoc <- function(path, readme, file = NULL) {
    if (length(path) > 1) {
        x <- path
    } else {
        x <- suppressWarnings(readLines(path))
    }
    y <- suppressWarnings(readLines(readme))
    start <- which(grepl("<h1></h1>", x))
    end <- which(grepl("<h2>Help topics</h2>", x))
    x <- c(x[1:start], "", y, "", x[end:length(x)])
    if (!is.null(file)) {
        cat(paste(x, collapse="\n"), file = file)
    }
    return(x)
}

基本上，您创建一个外部文档以插入自述部分。我在 qdap 中使用了它，您可以通过这个脚本看到我是如何使用它来创建staticdoc 网站的。

于 2013-02-10T20:54:51.510 回答