Qu'est-ce qu'un bon usage de la fonction 'commentaire' dans R?

Je viens de découvrir la commentfonction dans R. Exemple:

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

C'est la première fois que j'utilise cette fonction et je me demandais quelles en sont les utilisations courantes / utiles. Puisqu'il est assez difficile de rechercher "R comment" dans google et de trouver des résultats pertinents, j'espérais que quelqu'un ici pourrait partager son expérience.

Pour seconder @Gavin, Frank Harrell a mis au point des méthodes efficaces pour gérer data.frame annoté en R dans son package Hmisc . Par exemple, les fonctions label()et units()permettent d'ajouter des attributs dédiés aux objets R. Je les trouve très utiles pour produire un résumé de data.frame (avec, par exemple describe()).

Un autre moyen utile d'utiliser un tel attribut supplémentaire consiste à appliquer un horodatage sur un jeu de données. J'ajoute également un attribut pour des éléments tels que la graine aléatoire, le numéro de pli (lorsque j'utilise la validation croisée k-kold ou LOO).

Une chose que je me trouve souvent dans mes scripts R pour une tâche d'analyse de données particulière est d'inclure des commentaires dans le script concernant les unités de variables dans mes trames de données. Je travaille avec des données environnementales et les chimistes et les écologistes semblent aimer utiliser un large éventail d’unités différentes pour les mêmes choses (mg L vs mu eq L , etc.). Mes collègues stockent généralement ces informations dans la ligne située immédiatement en dessous des noms de colonnes dans les feuilles Excel.$^{-1}$$^{-1}$

Je verrais comment()comme un bon moyen de joindre ces informations à un bloc de données pour référence future.

Des installations similaires existent dans d'autres packages, tels que la commande -notes- dans Stata . Nous l'utilisons pour documenter les détails complets d'une variable, par exemple les détails d'un test pour une mesure biochimique ou la formulation exacte de la question posée pour les données du questionnaire. C’est souvent trop d’informations pour le nom ou l’étiquette de la variable, l’une ou les deux étant affichées dans le résultat de chaque analyse impliquant la variable et il est donc préférable de la maintenir raisonnablement courte.

L’une des choses que je me découvre souvent est le suivi des commandes utilisées pour générer des données et des objets, et j’ai trouvé que le commentaire était un outil utile à cet égard.

'Matched.call.data' et 'generate.command.string' font l'affaire. Pas parfait, mais utile et utile pour '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] )

Permettez-moi de suggérer ma solution générale à la gestion des objets dans R: le repopackage. En l'utilisant, vous pouvez affecter à chaque variable un nom long, une description, un ensemble de balises, une URL distante, des relations de dépendance et également attacher des figures ou des fichiers externes génériques. Par exemple, le code source peut être stocké en tant qu'élément de référentiel et attaché aux ressources qu'il produit. Recherchez la dernière version stable sur CRAN ( install.packages("repo")) ou les derniers développements sur github . Un aperçu rapide ici . J'espère que ça aide.