readme in staticdocs

Question

staticdocs è un pacchetto Hadley Wickham che può creare pagine Web eleganti per un pacchetto. Ho used it con grande successo (anche se non ho ancora capito come aggiungere gli esempi senza errori) ma ogni volta devo riformattare manualmente la parte readme del file index.html che viene creato. Questo sembra sciocco come sembra dal ggplot2 staticdocs use che c'è un modo per impostare readme nel file indice all'interno di inst/staticdocs/.

In questo momento Hadley non ha documentato bene il pacchetto (staticdocs) e non sono sicuro di come modificare l'argomento readme/la voce di elenco nel file di indice. Qualcuno ha una guida su come dovrebbe essere il formato per questo? vale a dire il formato di come dovrebbe apparire la voce?

Answer 1

Fino Hadley e il suo team sono in grado di sviluppare staticdocs e la relativa documentazione di più qui è il mio lavoro in giro trovato in un 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) 
} 

In sostanza si crea un documento esterno da inserire nella porzione me leggere. Ho usato questo in qdap e puoi vedere come lo utilizzo nella creazione di staticdoc web site tramite this script.