Tag: roxygen

Roxygen ist eine in-source Dokumentationssystem für R. Sie basiert auf Doxygen, und ist eine alternative zu erstellen .Rd-Dateien, die es erstellt automatisch das Paket .Rd-Dateien aus dem in-source-Dokumentation. Sehen http://roxygen.org/ für mehr details.

Wie Sie richtig dokumentieren eine S3-Methode einer generischen von einem anderen Paket, mit Roxygen?

Anzahl der Antworten 3 Antworten
Schreibe ich ein Paket definiert eine neue Klasse, Landvermesser, und ein print Methode für diese, D. H. print.surveyor. Mein code funktioniert einwandfrei und ich benutze roxygen für inline-Dokumentation. Aber R CMD check eine Warnung ausgibt: Funktionen/Methoden mit

generieren markdown-Kommentare innerhalb der for-Schleife

Anzahl der Antworten 3 Antworten
Ich versuche zu generieren, die einen HTML-Bericht, mit knitr, basiert auf einem R-script for-Schleifen. Ich will generieren markdown Kommentare aus den Kommentaren innerhalb der for-Schleife, aber ich bin nicht sicher, ob es möglich ist. Hier ist ein

Bei der Dokumentierung in Roxygen: Wie mache ich eine detaillierte Liste, in @Daten?

Anzahl der Antworten 2 Antworten
Was ist die entsprechende syntax hinzufügen, um eine in Elemente untergliederte Liste zu roxygen2, zum Beispiel in der @Detailbereich? Kann ich ein latex-Liste-Umgebung? Scheint es, dass die Zeilenumbrüche werden einfach ignoriert, D. H. #' @details text describing