TL; DR
Sie sollten verwenden, cat()wenn Sie die print.*()Funktionen für S3-Objekte erstellen. Für alles andere sollten Sie verwenden, es message()sei denn, der Status des Programms ist problematisch. zB schlechte Fehler, der erzielbare ist gibt warning()vs. Show stoppen Fehler Anwendungen stop().
Tor
Das Ziel dieses Beitrags ist es, Feedback zu den verschiedenen Ausgabeoptionen zu geben, auf die ein Paketentwickler Zugriff hat, und wie die Ausgabe strukturiert werden sollte, die möglicherweise auf einem neuen Objekt oder auf Zeichenfolgen basiert.
R Ausgabeübersicht
Die traditionellen Ausgabefunktionen sind:
print()cat()message()warning()stop()
Jetzt senden die ersten beiden Funktionen ( print()und cat()) ihre Ausgabe an stdoutoder Standardausgabe. Die letzten drei Funktionen ( message(), warning(), und stop()) senden ihre Ausgabe an stderroder den Standardfehler. Das heißt, die Ergebnisausgabe eines Befehls wie lm()wird an eine Datei gesendet, und die Fehlerausgabe - falls vorhanden - wird an eine vollständig separate Datei gesendet. Dies ist besonders wichtig für die Benutzererfahrung, da die Ausgabe der Ergebnisse in Protokolldateien durch die Diagnose nicht überladen wird und Fehler zur schnellen Suche verfügbar sind.
Entwerfen für Benutzer und externe Pakete
Das Obige ist nun eher in einer E / A- Denkweise und nicht unbedingt in einem benutzerbezogenen Frameset dargestellt. Lassen Sie uns also im Kontext eines alltäglichen R-Benutzers eine gewisse Motivation dafür liefern. Insbesondere durch die Verwendung von 3-5 oder der stderrFunktionen kann deren Ausgabe unterdrückt werden, ohne über sink()oder mit dem Konsolentext zu basteln capture.output(). Die Unterdrückung kommt normalerweise in Form von suppressWarnings(), suppressMessages(), suppressPackageStartupMessages()und so weiter. Daher werden Benutzer nur mit ergebnisorientierten Ausgaben konfrontiert. Dies ist besonders wichtig, wenn Sie Benutzern die Flexibilität geben möchten, die textbasierte Ausgabe zu deaktivieren , wenn Sie dynamische Dokumente über Knitr , Rmarkdown oder Sweave erstellen .
Insbesondere knitrbietet chunk Optionen wie error = F, message = F, und warning = F. Dies ermöglicht die Reduzierung von Text, der einem Befehl im Dokument beigefügt ist. Darüber hinaus wird verhindert, dass die results = "hide"Option verwendet werden muss, mit der alle Ausgaben deaktiviert werden.
Besonderheiten der Ausgabe
drucken()
Als erstes haben wir einen Oldie, aber einen Goodie print(). Diese Funktion weist einige schwerwiegende Einschränkungen auf. Eine davon ist das Fehlen einer eingebetteten Verkettung von Begriffen. Das zweite und wahrscheinlich schwerwiegendere Problem ist die Tatsache, dass vor jeder Ausgabe [x]Zitate über den tatsächlichen Inhalt stehen. Das xbezieht sich in diesem Fall auf die zu druckende Elementnummer. Dies ist hilfreich für Debugging-Zwecke, hat aber darüber hinaus keinen Zweck.
z.B
print("Hello!")
[1] "Hello!"
Für die Verkettung verlassen wir uns auf die paste()Funktion, die synchron arbeitet mit print():
print(paste("Hello","World!"))
[1] "Hello World!"
Alternativ kann man die paste0(...)Funktion anstelle von verwenden paste(...), um die Standardverwendung von a spacezwischen Elementen zu vermeiden, die durch paste()den sep = " "Parameter von ' gesteuert werden. (auch bekannt als Verkettung ohne Leerzeichen)
z.B
print(paste0("Hello","World!"))
[1] "HelloWorld!"
print(paste("Hello","World!", sep = ""))
[1] "HelloWorld!"
Katze()
Auf der anderen Seite werden cat()all diese Kritikpunkte angesprochen. Vor allem des sep=" "Parameter der paste()ist Funktionalität gebaut eine in denen ein Schreiben überspringen paste()innerhalb cat(). Der cat()einzige Nachteil der Funktion ist jedoch, dass Sie neue Zeilen über das \nAnhängen am Ende oder fill = TRUE(verwendet die Standarddruckbreite) erzwingen müssen .
z.B
cat("Hello!\n")
Hello!
cat("Hello","World!\n")
Hello World!
cat("Hello","World!\n", sep = "")
HelloWorld!
Genau aus diesem Grund sollten Sie cat()beim Entwerfen einer print.*()S3-Methode verwenden.
Botschaft()
Die message()Funktion ist einen Schritt besser als gerade cat()! Der Grund dafür ist, dass sich die Ausgabe von herkömmlichem Klartext unterscheidet, da sie stderrstattdessen an gerichtet ist stdout. ZB Sie haben die Farbe von der Standardausgabe Schwarz auf Rot geändert, um die Aufmerksamkeit des Benutzers auf sich zu ziehen.
Darüber hinaus verfügen Sie über die integrierte paste0()Funktionalität.
message("Hello ","World!")
"Hello World!"
Darüber hinaus message()bietet ein Fehlerzustand, mit dem verwendet werden kanntryCatch()
z.B
tryCatch(message("hello\n"), message=function(e){cat("goodbye\n")})
goodbye
Warnung()
Die warning()Funktion ist nicht zufällig zu verwenden. Die Warnfunktion unterscheidet sich von der Nachrichtenfunktion hauptsächlich dadurch, dass ihr eine Zeile vorangestellt wird ( "Warning message:") und ihr Status als problematisch angesehen wird.
Sonstiges: Die gelegentliche Verwendung in einer Funktion kann beim Versuch, das Paket auf CRAN hochzuladen, versehentlich Herzschmerz auslösen, da Beispielprüfungen und Warnungen normalerweise als "Fehler" behandelt werden.
halt()
Zu guter Letzt haben wir stop(). Dies bringt Warnungen auf die nächste Ebene, indem die vorliegende Aufgabe vollständig beendet und die Kontrolle an den Benutzer zurückgegeben wird. Darüber hinaus hat es das schwerwiegendste Präfix mit dem "Error:"hinzugefügten Begriff .
message()signalisiere aber auch eine "Nachricht", diesuppressMessages()erfasst wird.suppressMessages()Unterdrücken Sie keine reine stderr-Ausgabe, z. B.suppressMessages(cat("hello\n", file=stderr()))zeigt sie immer nochhelloin der Konsole an.