R-Paket-Dokumentation auf eine Webseite exportieren

Ich habe ein R-Paket nach Hadley Wickham's instruction on how to build and document packages with Roxygen erstellt. Jetzt möchte ich die Hilfeseiten und Vignetten der Funktion in eine Menge HTML-Dateien exportieren, damit sie auch auf einer Website gelesen und verlinkt werden können. R-Paket-Dokumentation auf eine Webseite exportieren

Wenn ich in meiner Bibliothek sucht das installierte Paket gibt es einen HTML-Ordner, aber es enthält nur eine 00Index.html Seite. Gibt es eine einfache Möglichkeit, den Rest meiner Paketdokumentation (Hilfeseiten und Vignetten) zu exportieren?

Quelle

2015-06-17 Paul Rougieux

In welches Format soll die Vignette für die Aufnahme in das Paket gerendert werden? –

Die Vignette sollte vorzugsweise im PDF-Format vorliegen, da die Parzellen etwas weniger Platz benötigen, aber beide gut sind. Ich kann Vignetten sowohl im PDF- als auch im HTML-Format exportieren. Meine Frage ist mehr über den Export der Funktionsdokumentation in HTML-Dateien. –

Sie könnten Hadley Wickhams in Entwicklung (d. H. Nicht auf CRAN) Paket staticdocs verwenden.

Alternativ, wenn Sie die gerenderten Rd Dateien haben, können Sie die jeweils zu HTML mit der Nutzenfunktion Rd2HTML aus den Tools Paket umwandeln, die Schiffe mit R. Lesen Sie mehr darüber ?tools::Rd2HTML

Quelle

2015-06-17 17:08:00

Danke, dass die Anleitung funktioniert, um meine Funktionsdokumentation von 'tradingflows :: addregion' in eine HTML-Datei zu exportieren, kann ich' Rd2HTML (Rd = "man/addregion.Rd", out = "/tmp/addregion.html", Paket) verwenden = "trafficflows") 'aber es gibt keine Verbindung zu dem Paket am Ende der generierten Datei. Gibt es eine Möglichkeit, dies zu einem Link zu machen? Ich überprüfe das staticdocs-Paket. –

Unter Verwendung des Funktionsnamens 'Rd2HTML' als Suchschlüsselwort fand ich [eine Funktion, die von Yihui Xie erstellt wurde] (http://yihui.name/en/2012/10/build-static-html-help/), die meine generiert statische Dokumentation mit Links. Wie ein Kommentar angibt, hilft das Ändern des Arbeitsverzeichnisses in 'system.file ('html', package =" mein_package_name ")' beim Erzeugen der statischen HTML-Dateien an der richtigen Stelle. –

Eine leichte Modifikation unter Verwendung von Yihui Xie's function to Build Static HTML Help Pages for R Packages, so dass statische Seiten im HTML-Verzeichnis des Pakets erstellt werden.

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 
}

Um es für Ihr Paket in der Entwicklung verwenden:

static_help("my_package_name")

Sie müssen diese Funktion jedes Mal, wenn Sie das Paket neu zu laufen bauen.

Quelle

2015-06-18 08:24:56

R-Paket-Dokumentation auf eine Webseite exportieren

Antwort

Verwandte Themen