Speicherort der Dateien bei Verwendung von @example-Tag mit roxygen2

Bei der Dokumentation einer Funktion mit roxygen2 ist es möglich, Beispiele in einer separaten Datei zu platzieren.Speicherort der Dateien bei Verwendung von @example-Tag mit roxygen2

Siehe hier: http://r-pkgs.had.co.nz/man.html "Anstatt Beispiele direkt in die Dokumentation aufzunehmen, können Sie sie in separate Dateien einfügen und @example path/relative/to/packge/root verwenden, um sie in die Dokumentation einzufügen."

und hier: http://roxygen.org/roxygen2-manual.pdf

z.B.

Meine Frage ist: Welchen Pfad sollte verwendet werden, um die Beispiel R-Dateien zu speichern?

Quelle

2014-09-30 wannymahoots

'inst/examples'? – jdharrison

Ich denke/inst/bewegt sich zu/bei der Installation des Pakets? Ich schätze, das spielt keine Rolle, wenn die Dokumentation bereits erstellt wurde? – wannymahoots

Ja 'inst/examples' sollte in' examples' verschoben werden und ich denke, dass Sie dann in Ihrer Dokumentation auf '/ examples' verweisen können. – jdharrison

Die geeignete Stelle für Beispiele in Ihrem roxygen verwendet wird:

inst/examples/

Die roxygen Zeile sollte dann sein:

#' @example inst/examples/add.R

Ist die gute Praxis? Ich denke, es ist, da:

Es leichter ausführen macht, zu verändern und die Beispiele zu testen, während der Entwicklung
Es macht es möglich (im Prinzip zumindest) an verschiedenen Orten die Beispiele wiederverwenden in der Dokumentation, z in der Vignette

Quelle

2014-09-30 11:43:08 Andrie

Ich finde es nützlich, wenn ich viele Zeilen für die Beispiele mit Einrückung habe, die ich beibehalten möchte. Meistens benutze ich @examples trotzdem. – wannymahoots

Speicherort der Dateien bei Verwendung von @example-Tag mit roxygen2

Antwort

Verwandte Themen