Was ist eine gute Verwendung der 'Kommentar'-Funktion in R?

Ich habe gerade die commentFunktion in R entdeckt. Beispiel:

x <- matrix(1:12, 3,4)
comment(x) <- c("This is my very important data from experiment #0234",
                "Jun 5, 1998")
x
comment(x)

Dies ist das erste Mal, dass ich diese Funktion besuche und mich frage, welche häufigen / nützlichen Verwendungen es gibt. Da es ziemlich schwierig ist, in Google nach "R comment" zu suchen und relevante Ergebnisse zu finden, hatte ich gehofft, dass jemand hier seine Erfahrungen mitteilt.

Zum zweiten Mal hat Frank Harrell in seinem Hmisc- Paket effiziente Methoden entwickelt, um mit Anmerkungen versehene data.frame-Dateien in R zu verarbeiten . Mit den Funktionen label()und units()können Sie beispielsweise R-Objekten dedizierte Attribute hinzufügen. Ich finde sie sehr praktisch, wenn ich eine Zusammenfassung von data.frame (z describe(). B. mit ) erstelle .

Eine weitere nützliche Möglichkeit, ein solches zusätzliches Attribut zu verwenden, besteht darin, einen Zeitstempel auf einen Datensatz anzuwenden. Ich füge auch ein Attribut für Dinge wie Random Seed, Fold Number (wenn ich k-kold oder LOO Cross-Validation verwende) hinzu.

$^{-1}$$^{-1}$

Ich würde es comment()als eine gute Möglichkeit sehen, diese Informationen als zukünftige Referenz an einen Datenrahmen anzuhängen.

Ähnliche Funktionen gibt es in anderen Paketen, z. B. im Befehl -notes- in Stata . Wir verwenden dies, um vollständige Details einer Variablen zu dokumentieren , z. B. Details eines Assays für eine biochemische Messung oder den genauen Wortlaut der Frage, die für Fragebogendaten gestellt wurde. Dies sind oft zu viele Informationen für den Variablennamen oder die Bezeichnung, von denen eine oder beide in der Ausgabe jeder die Variable betreffenden Analyse angezeigt werden und daher angemessen kurz gehalten werden sollten.

Eines der Dinge, die ich häufig tue, ist das Verfolgen der Befehle, die zum Generieren von Daten und Objekten verwendet werden, und der Kommentar hat sich als nützliches Werkzeug dafür erwiesen.

Die 'matched.call.data' und 'generate.command.string' machen den Trick. Nicht perfekt, aber hilfreich und eine Verwendung für 'comment ()'. :)

# Comments only accept strings...
# Substituting the escaped quotes ('\"') makes it prettier.
generate.command.string <- function( matched.call.data )
{
  command.string <- as.character( bquote( .( list( matched.call.data ) ) ) )
  sapply( bquote( .(command.string) ),
                  USE.NAMES=FALSE,
                  function( x )
                    gsub( "\\\"", "\'", as.list( match.call() )$x )[[2]] )
}

# Some generating function...
generate.matrix <- function( nrows, ncols, data=NA ) {
  # Some generated object
  mat <- matrix( data= data, nrow= nrows, ncol= ncols )

  matched.call.data <- do.call( "call",
                                c( list( as.character( match.call()[[1]] ) ),
                                lapply( as.list( match.call() )[-1], eval ) ) )
  comment( mat ) <- c( Generated= date(),
                       Command = generate.command.string( matched.call.data ) )

  mat
}

# Generate an object with a missing argument.
emptyMat <- generate.matrix( nrows=2, ncols=2 )
comment( emptyMat )

# Generate without formally stating arguments.
dataMat <- generate.matrix( 2, 2, sample(1:4, 4, replace= TRUE ) )
comment( dataMat )

# And with a longer command.
charMat <- generate.matrix( 3, 3,
                  c( 'This', 'is', 'a', 'much', 'longer',
                     'argument', 'section', 'that', 'wraps') )
comment( charMat )

# And with a variable.
myData <- c( 'An', 'expanded', 'command', 'argument')
charMat2 <- generate.matrix( 2, 2, myData )
comment( charMat2 )

# Create a new object from an original command.
Sys.sleep(1)
emptyMat2 <- eval( parse( text= comment( emptyMat )[['Command']] ) )
dataMat2 <- eval( parse( text= comment( emptyMat )[['Command']] ) )

# Check equality of the static matrices.
identical( emptyMat, emptyMat2 )

# The generation dates are different.
all.equal( emptyMat, emptyMat2, check.attributes= FALSE )
comment( emptyMat )['Generated'] <- NA
comment( emptyMat2 )['Generated'] <- NA
identical( emptyMat, emptyMat2 )

# Command argument structure still works too.
str( as.list( match.call(
  generate.matrix, parse( text=comment( charMat2 )[[ 'Command' ]] ) ) )[-1] )

Gestatten Sie mir, meine allgemeine Lösung für die Objektverwaltung in R: das repoPaket vorzuschlagen . Damit können Sie jeder Variablen einen langen Namen, eine Beschreibung, eine Reihe von Tags, eine Remote-URL und Abhängigkeitsrelationen zuweisen sowie Abbildungen oder generische externe Dateien anhängen. Beispielsweise kann Quellcode als Repository-Element gespeichert und an von ihm erstellte Ressourcen angehängt werden. Finden Sie die neueste stabile Version auf CRAN ( install.packages("repo")) oder die neueste Entwicklung auf Github . Ein kurzer Überblick hier . Ich hoffe es hilft.