2012-09-16 27 views
8

roxygen2 paketini kullanarak R paket için bir .Rd dosyası oluşturma hakkında bir sorum var.Paket .Rxygen dosyaları kullanarak roxygen2 paketi

Ar işlevleri belgelenmesi için, onları doldurmak, sonra işlev yukarıdaki yorumları oluşturmak için emacs'taki Cı-C, C-o kullanın ve, bana açıktır roxygenize("pkg") eklenmiştir. Bu şekilde R fonksiyonları için .Rd dosyalarım var. Ancak, veri örnekleri ve paketin kendisi için .Rd dosyasını nasıl alacağımı bilmiyorum. Şu anda data.Rd ve promptPackage("pkg") üretmek için prompt("data") kullanıyorum pkg-package.Rd. Bu dosyaları man klasörüne koyup bunları ayrı ayrı düzenlemeliyim. Verileri ve paketi, roxygen2 kullanarak R işlevlerini belgelemeye benzer şekilde nasıl belgeleyebilirim?

Çok teşekkür ederim! Sana pkg-package.Rd için aynı yapabileceği şüpheli

#' This is data to be included in my package 
#' 
#' @name data-name 
#' @docType data 
#' @author My Name \email{[email protected]@roxygen.org} 
#' @references \url{data_blah.com} 
#' @keywords data 
NULL 

: veriler için

cevap

7

, anlaşılacağı this previous question on SO bakın. o roxygen biçiminde olması gerekiyorsa,

+1

Yardımcı önerileriniz için teşekkürler Dirk! .Rd dosyaları oluşturmak için 'prompt()' ve 'promptPackage()' ı kullandım ve daha sonra .Rd dosyalarını hem veri hem de paketin kendisi için "roxygen" biçimine çevirmek için 'rd2roxygen' paketini kullanıyorum. Mükemmel çalışıyorlar :) – alittleboy

İlgili konular