roxygen2

Fragen
roxygen2 ist ein Doxygen-ähnliches In-Source-Dokumentationssystem für Rd, Kollatierung und NAMESPACE. Seine primäre Verwendung besteht darin, R-Funktionen in Übereinstimmung mit der Funktionsdefinition zu dokumentieren.
2
Antworten

Wie roxygen Kommentare in Rstudio wechseln?

Bei Roxygen-Kommentaren werden Zeilen mit #' vorangestellt. Wenn man Beispiele für Funktionen schreibt und testet, ist es schön, Kommentare ein- und ausschalten zu können. Ich könnte den Code kopieren und einfügen und zurück zu vim und entfer...
05.10.2013, 08:08
1
Antwort

Dokumentieren von Funktionsabschlüssen

Angenommen, ich habe eine Funktion in meinem Paket geschlossen, zum Beispiel %Vor% Was ist der korrekte (in der offiziellen CRAN Sinne) Weg, diese Funktion zu dokumentieren? Insbesondere Ich möchte roxygen2 verwenden Ich möchte Do...
23.10.2012, 09:50
1
Antwort

Funktion aus dem R-Paket-Handbuch ausschließen

Ich schreibe ein R-Paket und dokumentiere alle meine Funktionen mit roxygen2. Ich möchte jedoch nicht, dass alle Funktionen im Handbuch des Pakets erscheinen. Wie kann ich angeben, welche Funktionen im Handbuch des Pakets erscheinen sollen oder...
04.03.2016, 17:00
2
Antworten

Wie kann ich die Sortierreihenfolge in Roxygen2 angeben?

Die roxygen2-Dokumentation mit devtools verwenden document function generiert automatisch ein Collate: -Feld im Paket DESCRIPTION, unabhängig davon, ob die Paketbibliotheksdateien in einer bestimmten Reihenfolge geladen werden müssen oder...
31.08.2013, 02:53
2
Antworten

Fehler beim Erstellen des R-Pakets mit roxygen2

Ich habe 2 Dateien, Rfile.R und Cppfile.cpp. Inhalt in Cppfile.cpp: %Vor% Inhalt in Rfile.R: %Vor% Ich möchte ein R-Paket basierend auf den 2 Dateien erstellen. Ich benutze die neuesten Versionen von Rstudio und Roxygen2. Ich habe...
26.05.2014, 12:15
1
Antwort

Anzeige der nummerierten Liste im R-Paket

Ich habe Probleme, eine nummerierte Liste zur Anzeige in der R-Pakethilfe zu erhalten. Folgendes habe ich in roxygen: %Vor% Dies wird ohne Zahlen angezeigt. Nachdem ich die Datei gespeichert habe, klicke ich auf Build & Reload in RSt...
10.02.2018, 16:27
1
Antwort

Paket .RD-Dateien mit dem Paket roxygen2

Ich habe eine Frage zum Erstellen einer .RD-Datei für mein R-Paket mit dem roxygen2 -Paket. Es ist mir klar, dass ich zur Dokumentation von R-Funktionen C-c C-o in Emacs verwenden kann, um Kommentare über der Funktion zu generieren, und fü...
16.09.2012, 18:10
1
Antwort

roxygen2 (Version 5.0) erstellt fälschlicherweise eine Dokumentation, wenn # 'innerhalb der Funktion auftritt

Betrachten Sie die folgende Definition der R-Funktion, die mit roxygen2 (Version & gt; = 5.0) zu dokumentieren ist %Vor% Wenn Sie devtools :: document () verwenden, um dies zu dokumentieren, wird der folgende Fehler ausgegeben:    Warnmel...
04.11.2015, 18:57
1
Antwort

RStudio: Build und reload fügt dem Feld 'suggestions' in der Datei DESCRIPTION eine Leerzeile hinzu

Wenn ich eine Build & Reload aus RStudios Build -Fenster starte, erhalte ich die Nachricht %Vor% und tatsächlich, wenn ich schaue, enthält meine BESCHREIBUNG-Datei eine Leerzeile im Feld Suggests . Wenn ich das lösche, wird es er...
04.06.2013, 17:27
2
Antworten

Dokumentieren Sie eine glänzende Anwendung

Gibt es eine Möglichkeit, Dokumentation für eine glänzende Anwendung zu generieren? Es wird sehr schwierig, eine glänzende Anwendung ohne Dokumentation aufrechtzuerhalten. Es scheint, dass das gesamte Ökosystem der Tests / Dokumentation fü...
08.07.2015, 22:33