2010-02-23 11 views
9

Ich habe gerade angefangen mit dem roxygen Paket herumzuspielen und ich bin sehr zufrieden mit den bisherigen Ergebnissen. Wie auch immer, ich frage mich, gibt es eine Möglichkeit, roxygen anzugeben, dass bestimmte Funktionen ignoriert werden sollten, die nicht für den Benutzer zugänglich sind?Kann Roxygen Nichtbenutzerfunktionen ignorieren?

Konkret würde ich lieber keine .Rd Datei Pop-up haben, weil ich den .onLoad() Haken in meinem Paket verwende. Diese Funktion ist bereits im Paket base dokumentiert, daher gibt es keinen Grund für mich, es erneut zu dokumentieren.

Antwort

14

Nun, ich fand und durchforstete die Roxygen-devel-Liste um R-forge, um zu sehen, wann dies implementiert werden würde, und es scheint bereits in der Version von Roxygen zu sein, die auf CRAN ist. Der Schlüssel besteht darin, use.Rd2=TRUE anzugeben, wenn roxygenize() aufgerufen wird. In diesem Modus überspringt Roxygen das Erstellen von Dokumentationen für alle Funktionen, denen keine Roxygen-Kommentare vorangestellt sind.

+1

+1 Danke, dass Sie uns darauf aufmerksam gemacht haben. – Shane

+3

In roxygen2 können Sie auch '@ noRd' verwenden, um die Erstellung von Rd-Dateien zu unterdrücken, selbst wenn Sie roxygen2-Dokumentation haben. – hadley

2

Dies ist auf ihrer Aufgabenliste - in der nächsten Version werden nur Funktionen mit roxygen Dokumentation Man-Dateien erstellen.

Verwandte Themen