5

staticdocsは、パッケージ用の気の利いた Web ページを作成できる Hadley Wickham パッケージです。私はそれを使って大成功を収めました (ただし、エラーなしで例を追加する方法はまだわかりません) が、毎回、作成されたindex.htmlファイルの readme 部分を手動で再フォーマットする必要があります。ggplot2 staticdocsの使用から見えるように、これはばかげているように見えますinst/staticdocs/。

現在、Hadley はパッケージについて十分に文書化しておらず (staticdocs)、インデックス ファイルの readme 引数/リスト エントリを変更する方法がわかりません。これのフォーマットがどのように見えるべきかについて誰かがガイダンスを持っていますか; つまり、エントリがどのように見えるべきかのフォーマット?

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

基本的に、read me 部分に挿入する外部ドキュメントを作成します。これを qdap で使用しました。このスクリプトを使用してstaticdoc Web サイトを作成する際にどのように使用するかを確認できます。

于 2013-02-10T20:54:51.510 に答える