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 entfernen oder fügen Sie diese Kommentare hinzu, aber das ist nicht sehr elegant.
Aktualisieren : Wenn man lateral denkt, ist die Verwendung von @example examples/foo.r eine Alternative, um zu vermeiden, Roxygen-Kommentare für den eigentlichen Beispielcode verwenden zu müssen (dh, das Beispiel aus einer Datei zu beziehen, examples/foo.r ).
Sie können eine eigene Funktion schreiben, die Beispielcode aus Ihrer R-Datei extrahiert. Dies ist analog zu purl in knit package oder Stangle . Hier ein Beispiel dafür, was Sie tun können. Die Funktion ist nicht effizient, aber ich schreibe es nur, um die Idee zu zeigen. Es sollte ein guter Startpunkt sein. Es geht auch davon aus, dass Sie bereits Ihre R-Datei beziehen oder zumindest, dass die dokumentierte Funktion in der R-Sitzung bereits existiert.
Dann kannst du es beispielsweise so nennen:
%Vor%In Bezug auf Ihre vorgeschlagene Alternative:
Wenn Sie STRG + [Eingabetaste] innerhalb eines Roxygen2 @examples -Blocks drücken, sendet Rstudio den ausgewählten Code (Linie oder hervorgehobener Abschnitt) an die R-Konsole. Um zu verwenden, deklarieren Sie einfach den @examples -Code-Block in einer Zeile, die Ihrem von roxygen kommentierten Code vorausgeht.
Sie können einen @examples -Block irgendwo in Ihren Code setzen. Dies wird zu einem Problem, wenn Sie ein Paket entwickeln und den Block für den vorgesehenen Zweck verwenden.
Wenn Sie nach einer Möglichkeit suchen, Code umzuschalten, würde ich den von @Roman vorgeschlagenen Ansatz in den Kommentaren zu Ihrer Frage verwenden.