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

StackOverflow https://stackoverflow.com/questions/4099963

  •  29-09-2019
  •  | 
  •  

Frage

Ich habe ‚package.skeleton ()‘ vor .rd Hilfe-Dateien ein paar Monate zu generieren. Ich habe diese Dateien bearbeitet, und ich habe auch die Funktionen, entfernt einige Funktionen, andere hinzugefügt geändert. Gibt es eine Funktion, die automatisiert die Rd-Dateien aktualisieren?

update

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

Wie der Name schon sagt, ermöglicht dieses Paket eine nachträglich einfügen Dokumentation zur Zeit in .rd in .R-Dateien enthalten ist. Klingt wie ein vielversprechender Ansatz für beide Lern ??roxygen und für Pakete zur Zeit in der Entwicklung R-Pakete umzuwandeln. Woo hoo. Dank Yihui!

Basierend auf den Antworten von Joshua und Yihui, die Antwort zu sein scheint: ermöglicht roxygen automatische Aktualisierung der Rd-Dateien usw. basierend auf Änderungen in der Quelle .R Code, und wenn ich bin mit roxygen derzeit nicht Rd2roxygen kann mir helfen, migrieren.

War es hilfreich?

Lösung

Rd2roxygen wurde, um Hilfe Paket Entwickler konzipiert, die schon „stecken“ in den rohen Rd Dateien aber wollen roxygen wechseln - es kann Rd Dateien verarbeiten und den R-Skripte mit roxygen Kommentaren zu aktualisieren. Von da an können Sie beginnen, die Macht des roxygen zu genießen. So Rd2roxygen ist keine direkte Antwort, aber es könnte Sie mit dem Übergang zu helfen.

Andere Tipps

Dies ist nicht speziell auf Ihre Frage beantworten, aber Sie können in interessiert sein Roxygen .

Nein, ich denke nicht.

Aber man kann wieder laufen package.skeleton() für neue oder geänderte Funktionen versuchen und diese dann mit der Hand zusammenführen.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top