Gibt es eine Möglichkeit, die Dokumentation in einem R-Paket automatisch zu aktualisieren?

7

Ich habe 'package.skeleton ()' verwendet, um .Rd-Hilfedateien vor ein paar Monaten zu generieren. Ich habe diese Dateien bearbeitet, und ich habe auch die Funktionen geändert, einige Funktionen entfernt, andere hinzugefügt. Gibt es eine Funktion, die das Aktualisieren der Rd-Dateien automatisiert?

aktualisieren

Ein schönes Paket wurde gerade veröffentlicht Rd2roxygen , es wird vom Autor beschrieben Yihui Xie auf seinem Blog .

Wie der Name schon sagt, erlaubt es dieses Paket, nachträglich in .Rd enthaltene Dokumentation in .R-Dateien einzufügen. Klingt nach einem vielversprechenden Ansatz für das Erlernen von Roxygen und für das Konvertieren von derzeit in Entwicklung befindlichen Paketen in R-Pakete. Woo hoo. Danke Yihui!

Basierend auf den Antworten von Joshua und Yihui scheint die Antwort zu lauten: roxygen ermöglicht die automatische Aktualisierung von Rd-Dateien usw. basierend auf Änderungen im Quellcode von .R, und wenn ich roxygen derzeit nicht verwende , Rd2roxygen kann mir helfen, zu migrieren.

    
David LeBauer 04.11.2010, 18:30
quelle

3 Antworten

10

Rd2roxygen wurde entwickelt, um Paketentwicklern zu helfen, die in den rohen Rd-Dateien "steckengeblieben" sind, aber zu roxygen wechseln möchten - es kann Rd-Dateien verarbeiten und die R-Skripte mit roxygen-Kommentaren aktualisieren. Von nun an können Sie beginnen, die Macht von roxygen zu genießen. Also Rd2roxygen ist keine direkte Antwort, aber es könnte Ihnen beim Übergang helfen.

    
Yihui Xie 01.01.2011, 06:42
quelle
9

Dies beantwortet nicht speziell Ihre Frage, aber Sie könnten sich für Roxygen interessieren.

    
Joshua Ulrich 04.11.2010 18:41
quelle
1

Nein, das glaube ich nicht.

Aber Sie könnten versuchen, package.skeleton() für neue oder geänderte Funktionen erneut auszuführen und dann diese von Hand zusammenzuführen.

    
Dirk Eddelbuettel 04.11.2010 18:33
quelle

Tags und Links