Can Roxygen ignorieren nicht-Benutzerfunktionen?

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

  •  22-09-2019
  •  | 
  •  

Frage

Ich habe nur spielen beginne mit dem roxygen Paket um, und ich habe sehr zufrieden mit den bisherigen Ergebnissen. Ich frage mich jedoch ist es eine Möglichkeit, roxygen zu präzisieren, dass es bestimmte Funktionen ignorieren sollte, die nicht vom Benutzer zugänglich sind?

Insbesondere würde ich lieber keine .Rd Datei auftauchen, weil ich die .onLoad() Haken in meinem Paket bin mit. Diese Funktion ist bereits in dem base Paket dokumentiert, so gibt es keinen Grund für mich zu re-Dokument es.

War es hilfreich?

Lösung

Nun habe ich endlich gefunden und die Roxygen-devel Liste unter R-Schmiede durchsucht um zu sehen, wenn dies umgesetzt werden würde, und es scheint, bereits in der Version von Roxygen zu sein, die auf CRAN ist. Der Schlüssel ist use.Rd2=TRUE angeben, wenn roxygenize() Aufruf. In diesem Modus wird Roxygen Dokumentation für alle Funktionen der Erstellung überspringen, die von Roxygen Kommentare nicht vorangehen.

Andere Tipps

Dies ist auf ihrer Liste zu tun - in der nächsten Version, nur Funktionen mit roxygen Dokumentation werden die Mensch-Dateien erstellen.

Verwenden Sie das Schlüsselwort internal Feld ( d. @keywords internal) die Funktion aus der Dokumentation zu entnehmen und nur für erfahrene Benutzer zur Verfügung zu stellen. Quelle:. roxygen2 Vignette

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