Как правильно задокументировать метод S3 универсального пакета из другого пакета, используя Roxygen?

Я пишу пакет, который определяет новый класс, инспектор и для этого метод print , то есть print.surveyor . Мой код работает нормально, и я использую roxygen для встроенной документации. Но R CMD check выдает предупреждение:

Функции / методы с использованием в объект документации 'print.surveyor' но не в коде: print

Я использовал следующие две страницы, написанные Хэдли, в качестве вдохновения: Пространства имен и Документирование функций , оба из которых заявляют, что правильный синтаксис - @method function-name class

Итак, мой вопрос: каков правильный способ документирования метод print для моего нового класса, использующего Roxygen? И, более конкретно, как мне избавиться от предупреждения?


Вот мой код: (В документации с комментариями указаны попытки исправить это, но ни одна из них не сработала.)

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

И кислородный вывод, то есть 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}}

45
задан Reinstate Monica - G. Simpson 29 March 2013 в 19:13
поделиться