¿Cómo documentar correctamente un método S3 de un genérico de un paquete diferente, utilizando Roxygen?
Estoy escribiendo un paquete que define una nueva clase, topógrafo y unaprint
método para esto, es decir,print.surveyor
. Mi código funciona bien y uso roxygen para la documentación en línea. PeroR CMD check
emite una advertencia:
Funciones / métodos con uso en el objeto de documentación 'print.surveyor' pero no en el código: print
He usado las siguientes dos páginas, escritas por Hadley, como inspiración: Espacios de nombres y Funciones de documentación, los cuales establecen que la sintaxis correcta es@method function-name class
Entonces mi pregunta es: ¿Cuál es la forma correcta de documentar elprint
método para mi nueva clase usando Roxygen? Y más específicamente, ¿cómo me deshago de la advertencia?
Aquí está mi código: (La documentación comentada indicaba intentos de arreglar esto, ninguno de los cuales funcionó).
#' Prints surveyor object.
#'
#' Prints surveyor object
#'
## #' @usage print(x, ...)
## #' @aliases print print.surveyor
#' @param x surveyor object
#' @param ... ignored
#' @S3method print surveyor
print.surveyor <- function(x, ...){
cat("Surveyor\n\n")
print.listof(x)
}
Y la salida oxigenada, es decir,print.surveyor.Rd
:
\name{print.surveyor}
\title{Prints surveyor object.}
\usage{print(x, ...)
#'}
\description{Prints surveyor object.}
\details{Prints surveyor object
#'}
\alias{print}
\alias{print.surveyor}
\arguments{\item{x}{surveyor object}
\item{...}{ignored}}