2012-09-16 13 views
8

Tengo una pregunta sobre cómo crear un archivo .Rd para mi paquete R utilizando el paquete roxygen2.Paquete de archivos .Rd con el paquete roxygen2

Tengo claro que, para documentar las funciones R, puedo usar C-c C-o en emacs para generar comentarios sobre la función, y luego completarlos, seguido de roxygenize("pkg"). De esta manera, tengo archivos .Rd para las funciones R. Sin embargo, no estoy seguro de cómo puedo obtener el archivo .Rd para los ejemplos de datos y el paquete en sí. Actualmente, estoy usando prompt("data") para generar data.Rd y promptPackage("pkg") para generar pkg-package.Rd. Tengo que poner estos archivos en la carpeta man, y luego editarlos por separado. ¿Cómo puedo documentar los datos y el paquete de forma similar a como se documentan las funciones R usando roxygen2?

¡Muchas gracias!

Respuesta

7

Para los datos, lo que sugiere ver this previous question on SO:

#' 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 

sospecharía que se puede hacer lo mismo para pkg-package.Rd. Si debe estar en formato roxygen, considere

+1

Gracias Dirk por las útiles sugerencias! Usé 'prompt()' y 'promptPackage()' para generar archivos .Rd, y ​​luego uso el paquete 'rd2roxygen' para traducir los archivos .Rd al formato' roxygen', tanto para los datos como para el paquete en sí. Funcionan perfectamente :) – alittleboy

Cuestiones relacionadas