Pakiet .Rd pliki przy użyciu pakietu roxygen2

Question

Mam pytanie dotyczące tworzenia pliku .Rd dla mojego pakietu R przy użyciu pakietu roxygen2.

Jest dla mnie jasne, że do dokumentowania funkcji R, mogę użyć C-c C-o w emacs do wygenerowania komentarzy nad funkcją, a następnie wypełnić je, a następnie roxygenize("pkg"). W ten sposób mam pliki .Rd dla funkcji R. Jednak nie jestem pewien, w jaki sposób można uzyskać plik .Rd dla przykładów danych i samego pakietu? Obecnie używam prompt("data") do generowania danych.Rd i promptPackage("pkg") w celu wygenerowania pkg-package.Rd. Muszę umieścić te pliki w folderze man, a następnie edytować je osobno. Jak mogę dokumentować dane i pakować w podobny sposób, jak dokumentowanie funkcji R za pomocą roxygen2?

Dziękuję bardzo!

Answer 1

Dla danych, patrz this previous question on SO co sugeruje:

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

Podejrzewam, że można zrobić to samo dla pkg-package.Rd. Jeśli musi być w formacie roxygen rozważyć

• tłumaczenie instrukcji lub
• rd2roxygen package.