Rの「コメント」機能の良い使用法は何ですか？

commentRで関数を発見しました。例：

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

この機能を使用したのはこれが初めてであり、この機能の一般的/有用な使用法について疑問に思っていました。グーグルで「Rコメント」を検索して関連する結果を見つけることは非常に難しいので、ここの誰かが彼の経験と共有することを望んでいました。

2番目の@Gavinに、フランクハレルはHmiscパッケージでRの注釈付きdata.frameを処理する効率的な方法を開発しました。たとえば、label()およびunits()関数を使用すると、Rオブジェクトに専用の属性を追加できます。data.frameの概要を作成する場合（たとえば、describe()）に非常に便利です。

このような追加属性を使用する別の便利な方法は、データセットにタイムスタンプを適用することです。また、ランダムシード、フォールドナンバーなどの属性を追加します（k-koldまたはLOOクロス検証を使用する場合）。

特定のデータ分析タスクのためにRスクリプトでよく行うことの1つは、データフレームの変数の単位に関するコメントをスクリプトに含めることです。私は環境データを使用しており、化学者と生態学者は同じことに対して広範囲の異なるユニットを使用することを楽しんでいるようです（mg L − 1 vs mu eq L − 1など）。私の同僚は通常、この情報をExcelシートの列名のすぐ下の行に保存します。$^{-1}$$^{-1}$

comment()今後の参考のために、この情報をデータフレームに添付する良い方法だと思います。

Stataの-notes-コマンドなど、他のパッケージにも同様の機能があります。これを使用して、変数の完全な詳細、たとえば生化学的測定のアッセイの詳細、または質問票データを求められた質問の正確な表現を文書化します。多くの場合、これは変数名またはラベルにとって情報が多すぎるため、その一方または両方が変数に関連するすべての分析の出力に表示されるため、合理的に短く保つのが最善です。

私がよくやっていることの1つは、データとオブジェクトを生成するために使用されるコマンドを追跡し、コメントがこのための便利なツールであることを発見したことです。

「matched.call.data」と「generate.command.string」がトリックを行います。完璧ではありませんが、有用であり、「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] )

Rのオブジェクト管理に対する私の一般的な解決策を提案させてください：repoパッケージ。これを使用して、各変数に長い名前、説明、一連のタグ、リモートURL、依存関係を割り当てたり、図または一般的な外部ファイルを添付したりできます。たとえば、ソースコードをリポジトリアイテムとして保存し、それによって生成されたリソースに添付できます。CRAN（install.packages("repo")）で最新の安定版リリースを見つけるか、githubで最新の開発版を見つけてください。ここで簡単な概要。それが役に立てば幸い。