オブジェクトに備忘用のコメントをつける comment() 関数

R のオブジェクトに簡単なメモ代わりのコメントをつける

comment 関数は任意オブジェクトにメモ代わりのコメントをつける。 このコメントは print 関数では表示されない。詳しくは ?comment を参照。

「忘るるは人の常」、これは気が利いている。

> x <- matrix(1:12, 3, 4)
# x にコメント属性として二つの文字列を加える
> comment(x) <- c("This is my very important data from experiment #0234", "Jun 5, 1998")
> x  # コメントは表示されない！
     [,1] [,2] [,3] [,4]
[1,]    1    4    7   10
[2,]    2    5    8   11
[3,]    3    6    9   12
> comment(x)  # コメントを表示する
[1] "This is my very important data from experiment #0234"
[2] "Jun 5, 1998"
> print(x)  # print 関数では表示されない！
     [,1] [,2] [,3] [,4]
[1,]    1    4    7   10
[2,]    2    5    8   11
[3,]    3    6    9   12
> str(x)  # str 関数では表示される
 int [1:3, 1:4] 1 2 3 4 5 6 7 8 9 10 ...
 - attr(*, "comment")= chr [1:2] "This is my very important data from experiment #0234" "Jun 5, 1998"
> comment(x) <- c(comment(x), "revised Jun 7, 1998") # コメントを加える
> comment(x)
[1] "This is my very important data from experiment #0234"
[2] "Jun 5, 1998"
[3] "revised Jun 7, 1998"

## 日本語化 R でなくても日本語コメントなら大丈夫！
## オブジェクトを save, load しても大丈夫(らしい)
> comment(x) <- c("プロジェクト X データ","2003年11月12日")
> comment(x)
[1] "プロジェクト X データ" "2003年11月12日"
> str(x)
 int [1:3, 1:4] 1 2 3 4 5 6 7 8 9 10 ...
 - attr(*, "comment")= chr [1:2] "プロジェクト X データ" "2003年11月12日"

> test <- function (x) x^2
# 関数オブジェクトにもコメントを付けられる！
> comment(test) <- c("This is a test function.", "No meaning at all")
> comment(test)
[1] "This is a test function." "No meaning at all"
> test                                 # コメントは表示されない！
function (x) x^2
> comment(test) <- NULL  # コメントを消す
> comment(test)
NULL

最新の20件