R'deki 'comment' işlevinin iyi bir kullanımı nedir?

Ben sadece commentR'deki fonksiyonu keşfettim. Örnek:

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

Bu, bu fonksiyona ilk kez geldiğimde ve bunun ortak / yararlı kullanımlarının ne olduğunu merak ediyordum. Google’da "R yorumu" nu aramak ve alakalı sonuçlar bulmak oldukça zor olduğundan, burada birisinin bu deneyimi ile paylaşabileceğini umuyordum.

Frank Harrell @ Gavin'den ikinciye, Hmisc paketindeki R'deki açıklamalı data.frame ile başa çıkmak için etkili yollar geliştirdi . Örneğin, label()ve units()işlevleri R nesnelerine özel özellikler eklemenizi sağlar. Onları data.frame'in özetini verirken çok kullanışlı buluyorum (örneğin, ile describe()).

Böyle bir ekstra nitelik kullanmanın başka bir faydalı yolu, bir veri setine zaman damgası uygulamaktır. Ayrıca rastgele tohum, kat sayısı gibi şeyler için bir özellik eklerim (k-kold veya LOO çapraz doğrulama kullandığımda).

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

comment()Gelecekte başvurmak için bu bilgiyi bir veri çerçevesine eklemenin iyi bir yolu olarak görüyorum .

Stata'daki -notes-komutu gibi diğer paketlerde de benzer özellikler bulunmaktadır . Bunu , bir değişkenin tüm ayrıntılarını, örneğin biyokimyasal ölçüm için testin ayrıntılarını veya anket verileri için sorulan sorunun tam ifadesini belgelemek için kullanıyoruz. Bu genellikle değişken ismi veya etiketi için çok fazla bilgidir; bunlardan biri veya her ikisi de değişkeni içeren her analizin çıktısında gösterilir ve bu nedenle en iyi şekilde oldukça kısa tutulur.

Kendimi çok bulurken bulduğum şeylerden biri, veri ve nesneler üretmek için kullanılan komutları izlemektir ve yorumu bunun için yararlı bir araç olarak bulduk.

'Matched.call.data' ve 'construc.command.string' bu numarayı yapıyor. Mükemmel değil, ama yardımcı ve 'comment ()' için bir kullanım. :)

# 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] )

Genel çözümümü R: repopaketindeki nesne yönetimine önermeme izin verin . Kullanarak, her değişkene uzun bir ad, açıklama, bir etiket kümesi, uzak bir url, bağımlılık ilişkileri atayabilir ve ayrıca rakamlar veya genel harici dosyalar ekleyebilirsiniz. Örneğin, kaynak kodu bir depo öğesi olarak saklanabilir ve ürettiği kaynaklara eklenebilir. CRAN son kararlı sürümü (Bul install.packages("repo")) ya da en geç gelişimini github . Hızlı bir bakış burada . Umarım yardımcı olur.