если вы действительно хотите сделать метод видимым вне пространства имен пакета.
у пакет, который определяет новый класс, геодезист и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}}