Warum ist die Nachricht() die bessere Wahl als print() in R zu schreiben, ein Paket?

TL;DR

Sollten Sie verwenden cat() bei der print.* Funktionen für die S3-Objekte. Für alles andere verwenden, sollten Sie message() es sei denn, der Status des Programms ist problematisch. z.B. schlechte Fehler, der Ordner " Wiederherstellbare gibt warning() vs. show-stopping Fehler verwendet stop().

Ziel

Ziel dieses Beitrags ist es, feedback zu geben über die verschiedene Ausgabe-Optionen, die ein Paket-Entwickler Zugriff hat und wie sollte man die Struktur der Ausgabe, die potenziell auf ein neues Objekt oder basierend auf strings.

R Ausgang Übersicht

Den traditionellen output-Funktionen sind:

1. print()
2. cat()
3. message()
4. warning()
5. stop()

Nun, die ersten beiden Funktionen (print() und cat()) senden Sie Ihre Ausgabe stdout oder standard-Ausgabe. Die letzten drei Funktionen (message(), warning(), und stop()) senden Sie Ihre Ausgabe stderr oder die standard-Fehler. Das heißt, die Ergebnis output von einem Befehl wie lm() gesendet wird, um zu einer Datei, und der Fehler-Ausgabe - wenn vorhanden - an einen völlig separaten Datei. Dies ist besonders wichtig für die user experience als Diagnose-dann sind nicht überladen die Ausgabe der Ergebnisse in log-Dateien und Fehler sind dann verfügbar, um die Suche schnell durch.

Entwerfen für Benutzer und Externe Pakete

Nun, die oben ist gerahmt noch in eine I/O Denkweise und nicht unbedingt ein Benutzer-zugewandten frameset. Also, lassen Sie uns Ihnen einige motivation im Kontext des alltäglichen R Benutzer. Insbesondere durch die Verwendung von 3-5 oder die stderr Funktionen, die Ihren Ausgang in der Lage ist, unterdrückt werden, ohne basteln mit der Konsole text über sink(). Die Unterdrückung kommt normalerweise in form von suppressWarnings(), suppressMessages(), suppressPackageStartupMessages(), und so weiter. Damit der Benutzer nur konfrontiert mit dem Ergebnis konfrontiert Ausgabe. Dies ist besonders wichtig, wenn Sie planen, um Benutzern die Flexibilität, das ausschalten von text-basierte Ausgabe bei der Erstellung von dynamischen Dokumenten entweder über knitr, rmarkdown, oder Sweave.

Insbesondere knitr bietet chunk-Optionen wie error = F, message = F, und warning = F. Dies ermöglicht die Reduzierung der Begleittext einen Befehl in das Dokument. Außerdem wird so verhindert, dass die Notwendigkeit, die aus der Verwendung der results = "hide" option, dass würde Sie auf alle deaktivieren Ausgabe.

Besonderheiten der Ausgang

print()

Zuerst haben wir ein oldie aber ein goodie print. Diese Funktion hat einige schwerwiegende Einschränkungen. Einer von Ihnen ist der Mangel an embedded-Verkettung von Bedingungen. Die zweite und wahrscheinlich noch schwerer, ist die Tatsache, dass jeder Ausgabe vorangestellt ist [x] gefolgt von Zitaten rund um den eigentlichen Inhalt. Die x in diesem Fall bezieht sich auf die element-Nummer gedruckt werden. Dies ist nützlich für debugging-Zwecke, aber außerhalb, dass es nicht dazu.

z.B.

print("Hello!")

[1] "Hello!"

Für die Verkettung, wir verlassen uns auf die paste Funktion arbeitet synchron mit print:

print(paste("Hello","World!"))

[1] "Hello World!"

Alternativ kann man die paste0(...) Funktion anstelle von paste(...) zu vermeiden, die die Standard-Verwendung von a Raum zwischen den Elementen unterliegt paste()'s sep = " " parameter. (ein.k.eine Verkettung ohne Leerzeichen)

z.B.

print(paste0("Hello","World!"))

[1] "HelloWorld!"

print(paste("Hello","World!", sep = ""))

[1] "HelloWorld!"

cat()

Auf der anderen Seite cat() - Adressen all diese Kritiken. Vor allem die sep=" " parameter der paste() Funktionalität integriert ist, so dass ein überspringen schreiben paste() innerhalb cat(). Jedoch, die cat() Funktion der einzige Nachteil ist, Sie zu zwingen, neue Linien über \n an das Ende oder fill = TRUE (verwendet Standard-Druckbreite).

z.B.

cat("Hello!\n")
Hello!

cat("Hello","World!\n")
Hello World!

cat("Hello","World!\n", sep = "")
HelloWorld!

Dies ist auch der Grund, warum Sie verwenden sollten cat() bei der Gestaltung eines print.* S3-Methode.

message()

Den message() Funktion ist ein Schritt besser als gar cat()! Der Grund ist, warum die Ausgabe unterscheidet sich von traditionellen Klartext, wie es ist Regie zu stderr statt stdout. E. g. Sie verändert die Farbe aus der standard-Ausgabe von schwarz auf rot Ausgang zu fangen die Benutzer Auge.

Darüber hinaus haben Sie die gebaut paste0 Funktionalität.

message("Hello ","World!") # Note the space after Hello
"Hello World!"

Darüber hinaus message() bietet einen Fehlerzustand, kann verwendet werden, mit tryCatch()

z.B.

 tryCatch(message("hello\n"), message=function(e){cat("goodbye\n")})
 goodbye

warning()

Die Warnfunktion ist nicht etwas beiläufig. Die Warnung Funktion unterscheidet sich von der Nachricht Funktion in Erster Linie durch eine Linie preappended zu ("Warnung:") und seinen Zustand zu prüfen, problematisch zu sein.

Sonstiges: gelegentliche Nutzung in einer Funktion kann versehentlich auslösen, Herzschmerz, während Sie versuchen, laden Sie das Paket zu CRAN durch das Beispiel überprüft und Warnungen, die normalerweise behandelt werden, als "Fehler".

stop()

Last but not least, haben wir stop(). Dies dauert Warnungen auf die nächste Ebene, indem Sie vollständig zu töten die Aufgabe und zurückgeben der Steuerung an den Benutzer. Darüber hinaus hat es die meisten schweren Anhängsel mit dem Begriff "Fehler:" Hinzugefügt.