¿Cuál es un buen uso de la función 'comentario' en R?

Acabo de descubrir la commentfunción en R. Ejemplo:

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

Esta es la primera vez que llegué a esta función y me preguntaba cuáles son sus usos comunes / útiles. Dado que es bastante difícil buscar "comentarios R" en Google y encontrar resultados relevantes, esperaba que alguien aquí pudiera compartir su experiencia.

Para segundo @Gavin, Frank Harrell ha desarrollado formas eficientes de manejar data.frame anotado en R en su paquete Hmisc . Por ejemplo, las funciones label()y units()permiten agregar atributos dedicados a los objetos R. Los encuentro muy útiles cuando produzco un resumen de data.frame (por ejemplo, con describe()).

Otra forma útil de utilizar dicho atributo adicional es aplicar una marca de tiempo en un conjunto de datos. También agrego un atributo para cosas como semilla aleatoria, número de pliegue (cuando uso k-kold o LOO validación cruzada).

Una cosa que a menudo me encuentro haciendo en mis scripts R para una tarea particular de análisis de datos es incluir comentarios en el script sobre las unidades de variables en mis marcos de datos. Trabajo con datos ambientales y los químicos y ecologistas parecen disfrutar usando una amplia gama de unidades diferentes para las mismas cosas (mg L - 1 vs mu eq L - 1 , etc.). Mis colegas generalmente almacenan esta información en la fila inmediatamente debajo de los nombres de las columnas en las hojas de Excel.$^{-1}$$^{-1}$

Vería comment()como una buena manera de adjuntar esta información a un marco de datos para referencia futura.

Existen instalaciones similares en otros paquetes, como el comando -notes- en Stata . Usamos esto para documentar los detalles completos de una variable, por ejemplo, detalles del ensayo para una medición bioquímica, o la redacción exacta de la pregunta solicitada para los datos del cuestionario. Esto suele ser demasiada información para el nombre o la etiqueta de la variable, uno o ambos se muestran en el resultado de cada análisis que involucra la variable y, por lo tanto, es mejor mantenerlos razonablemente cortos.

Una de las cosas que me encuentro haciendo mucho es rastrear los comandos utilizados para generar datos y objetos, y he encontrado que el comentario es una herramienta útil para esto.

El 'matched.call.data' y 'generate.command.string' hacen el truco. No es perfecto, pero útil y un uso para '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] )

Permítanme sugerir mi solución general para la gestión de objetos en R: el repopaquete. Al usarlo, puede asignar a cada variable un nombre largo, una descripción, un conjunto de etiquetas, una URL remota, relaciones de dependencia y también adjuntar figuras o archivos externos genéricos. Por ejemplo, el código fuente puede almacenarse como un elemento de repositorio y adjuntarse a los recursos producidos por él. Encuentre la última versión estable en CRAN ( install.packages("repo")) o el último desarrollo en github . Una descripción rápida aquí . Espero eso ayude.