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:
Warnmeldungen:
1: @examples [TestFun.R # 8]: nicht übereinstimmende Klammern oder Anführungszeichen
Beachten Sie, dass im Abschnitt "Beispiele" DEFINITIV keine Klammern oder Anführungszeichen angegeben sind. Was verursacht das? Wie kann ich es beheben?
Dies ist auf die letzten Änderungen im Paket roxygen2 zurückzuführen. Aus den NEWS :
Der Inhalt dokumentierter Funktionen wird nun auch für roxygen-Kommentare analysiert. Dies ermöglicht z. B. das Dokumentieren eines Parametertyps in der Nähe dessen, wo dieser Typ geprüft wird, oder das Dokumentieren von Implementierungsdetails in der Nähe der Quelle und vereinfacht zukünftige Erweiterungen, wie die Dokumentation von R6-Klassen.
Dies bedeutet, dass Kommentare im Stil von roxygen-artigen innerhalb von Codeblöcken analysiert werden. Wenn der Code Ihres Pakets solche Kommentare in Funktionen enthält, möchten Sie sie wahrscheinlich durch einfache Kommentare ersetzen, z. B. #' durch # ersetzen. Nach dieser einmaligen Änderung sollten Sie keine roxygen-artigen Kommentare mehr in Codeblöcken verwenden, außer dies ist beabsichtigt.
Die folgende Befehlszeile (erfordert sed ) ersetzt alle Kommentare mit Leerzeichen-eingerücktem roxygen-Stil durch einfache Kommentare in allen Dateien im Unterverzeichnis R/ des aktuellen Verzeichnisses:
Passen Sie es Ihren Bedürfnissen an.