Question

staticdocs是一个Hadley Wickham软件包，它可以为包提供漂亮的网页。我used it取得了巨大的成功（虽然还没有弄清楚如何在没有错误的情况下添加示例）但每次我必须手动重新格式化创建的index.html文件的自述文件部分。这似乎很愚蠢，因为从ggplot2 staticdocs use看来有一种方法可以在inst/staticdocs/内的索引文件中设置自述文件。

现在Hadley还没有记录好的软件包（staticdocs），我不确定如何更改索引文件中的readme参数/列表条目。有没有人有关于这种格式应该是什么样子的指导;即，条目的外观格式？

Answer 1

直到Hadley及其团队能够开发staticdocs及其文档更多内容是我在very rough package找到的工作：

#' 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)
}

基本上，您创建一个外部文档以插入read me部分。我在qdap中使用了这个，你可以看到我如何通过staticdoc web site创建this script。

staticdocs中的自述文件

1 个答案: