Kann Roxygen wirklich R-Skript (kein Paket) wie Doxygen für C++?

Roxygen ist inspiriert von dem Doxygen-Dokumentationssystem, das von C, C++ - Programmierern verwendet wird. Ich habe Doxygen benutzt und finde es wirklich einfach, jedes Programm zu dokumentieren, solange du den Doxygen-Kommentar hast. Es generiert auch Call-Graphen für Functinos und Klassen. Ich dachte, roxygen würde genauso funktionieren, aber wenn ich nach roxygen help suche, finde ich nur eine Lösung, um R-Pakete zu dokumentieren.Kann Roxygen wirklich R-Skript (kein Paket) wie Doxygen für C++?

Ich habe Hadley Wickham online roxygen2 help überprüfen, aber das beschreibt nichts über die R-Skript-Dokumentation.

Meine Skripte werden manchmal 500-1000 Zeilen und hat mehrere Funktionen, die ich immer mit den Kommentaren dokumentieren. Ich möchte eine PDF- oder HTML-Dokumentation mit Graph-Viz-Diagrammen erstellen. Kann Roxygen Call-Graphen und Dokumente eigenständig R-Skripte erstellen?

Quelle

2016-05-20 Xtrim-a

Checkout ['knitr :: spin'] (http://yihui.name/knitr/demo/stitch/) Ich habe es schon mal benutzt und könnte es sein, wonach Sie suchen. Die Beispiele im Dokument geben Ihnen einen Eindruck von dem, was Sie erwarten können. – chappers

Danke! Ich denke, ich werde es benutzen. –

Nein, roxygen2 funktioniert nur zum Schreiben von Paketdokumentationen. Klingt für mich nach einem Tool zum Erzeugen von Berichten. Sie können knitr dafür verwenden. Sie können Code, Kommentare, Text, MathJax oder sogar LaTeX verwenden. Es unterstützt auch Inhaltsverzeichnis und Referenzen. Dies ist keineswegs eine erschöpfende Liste von Funktionen. Mit einigen logischen Einschränkungen können Sie unter anderem PDF- und HTML-Dokumente erstellen.

Quelle

2016-05-20 09:24:29

Ich habe versucht, Knittr :: Spin. Es funktioniert wie ein Berichtserstellungswerkzeug. Wie ich in meiner Frage erwähnt habe, suche ich nach einem Werkzeug, das Dokumentation aus der Programmstruktur und Kommentare in meinem Skript generieren wird. Ein solches Dokument enthält die Funktionsdefinitionen, Aufrufgraphen, das Argument und die Rückgabewerte der Funktionen und ein Inhaltsverzeichnis. Ich bin wirklich nicht auf der Suche nach einem Bericht mit Plots oder Werten aus der Ausgabe des Skripts. Ich suche nach einem Werkzeug, um eine Hilfedatei zu generieren, um mein Programm für andere und mich nach einem Jahr zu verstehen. –

@ Xtrim-ein ok, aber ich denke nicht, dass ein solches Werkzeug existiert. Wenn Sie bereit sind, in den sauren Apfel zu beißen und Ihre Kommentare in Markdown zu konvertieren, können Sie Ihr Skript auf diese Weise dokumentieren. –

Ich benutze knittr mit einigen Optionen und es macht einen guten Job für jetzt. Vielen Dank für Ihre Antworten! Ich hoffe, Doxygen wird seine Unterstützung für R irgendwann verlängern. –

Kann Roxygen wirklich R-Skript (kein Paket) wie Doxygen für C++?

Antwort

Verwandte Themen