Ist roxygen2 nur zur Dokumentation von R-Paketen oder auch für R-Projekte?

Ich habe eine Frage über die "roxygen2" Paket:Ist roxygen2 nur zur Dokumentation von R-Paketen oder auch für R-Projekte?

Ich habe eine Menge Tutorials gesehen, die Verwendung für Paketdokumentation (wie die großen "object documentation" Seite von Hadley Wickham)

So machen was, wenn ich tun Haben Sie R-Code, der kein Paket ist, sagen Sie ein R-Projekt? Können Sie R Projects auch mit roxygen2 dokumentieren?

Ich konnte immer noch die package.skeleton(name='RoxygenSkeleton', code_files = "Roxygen.R", force=TRUE) Funktion ausführen, um die grundlegende Paketstruktur zu erstellen, und .RD-Dateien wurden erstellt. Aber ich würde eine schöne Ausgabe in HTML oder PDF wünschen ...

Quelle

2016-08-17 Skybrush

Da Sie nur HTML-Dateien generieren möchten, können Sie einfach die '* .Rd'-Dateien generieren und dann [' tools :: Rd2HTML'] verwenden (https://stat.ethz.ch/R-manual/ R-devel/Bibliothek/tools/html/Rd2HTML.html). Es ist ein bisschen spartanisch, aber es erfüllt Ihre Grundanforderungen. – r2evans

@ r2evans "generiere die * .RD-Dateien" - wie? Soweit ich das beurteilen kann, ist dies mit der öffentlichen API von roxygen2 nicht möglich. Sieh meine Antwort. –

Ich glaube, ich habe versucht, etwas zu erreichen, was man vor ein paar Jahren versucht hat. Beende die Aufgabe nie vollständig, aber vielleicht ist sie für dich von Interesse? https://github.com/Dasonk/flydoc Und zumindest könnte die Methode, die in der "flyhelp" -Funktion verwendet wird, dir dabei helfen? https://github.com/Dasonk/flydoc/blob/master/R/flyhelp.R Mit diesem sagte der Code ist vier Jahre alt im Moment, so dass ich keine Garantien, dass es immer noch funktioniert – Dason

Roxygen funktioniert nur auf Paketen, von Design (my suggestion to change this wurde rund abgelehnt). Sie können Ihr Projekt natürlich zu einem Paket machen, und einige Leute empfehlen, dies zu tun.

Ich schaffte es, roxygen2 zu arbeiten außerhalb von Paketen für die Verwendung mit meinem modules, aber es ist ein Schmerz im Nacken, und fordert den Aufruf nicht exportierten APIs (was Sie nicht tun sollten).

Quelle

2016-08-17 14:38:36

Danke Konrad! Bei der Verwendung von Roxygen mit einem Projekt habe ich gesehen, dass es nur das "Skelett" (z. B. man-Repository mit .Rd drin) generiert hat, aber nicht wirklich richtig geschrieben meine Kommentare in den jeweiligen .RD-Dateien. Möglicherweise liegt das an der Verwendung eines "Projekts", nicht eines "Pakets". Vielen Dank, dass Sie uns die Problemumgehung gezeigt haben. – Skybrush

Ist roxygen2 nur zur Dokumentation von R-Paketen oder auch für R-Projekte?

Antwort

Verwandte Themen