Как получить тег использования автоматически заполненный roxygen2 в файлах Rd для методов S4

У меня есть пакет с комбинацией методов S3 и S4 (да, я знаю, но попробуйте написать S4 для sort(), as.matrix() и подобных...). Поэтому я придерживаюсь классического roxygen2 от CRAN (версия 2.2.2)

Я заметил, что что бы я ни пытался, я не могу получить, чтобы тег использования в файлах Rd заполнялся автоматически. Я знаю, что могу сделать это вручную, используя @usage, но я хочу, чтобы это было автоматизировано, так как у меня достаточно обширная база кода, и я не хочу пропустить какой-либо тег случайно.

Пример:

#' A small test function
#' 
#' This function tests roxygen2
#' @param x that's right, it's called x
#' @param ... some more stuff
#' 
#' @rdname testfun-methods
#' @aliases testfun
#' @docType methods
#' @export
setGeneric("testfun",function(x,...) standardGeneric("testfun"))

#' @rdname testfun-methods
#' @aliases testfun,matrix-method
#' @return the matrix minus 1
setMethod("testfun","matrix",function(x,...){x - 1})

#' @rdname testfun-methods
#' @aliases testfun,numeric-method
#' @return a vector plus 1
setMethod("testfun","matrix",function(x,...){x + 1})

Если я заверну это в пакет, roxygenize с помощью roxygen2 (и RStudio, если это имеет значение) и проверим файл справки, это будет выглядеть так:

\docType{methods}
\name{testfun}
\alias{testfun}
\alias{testfun,matrix-method}
\alias{testfun,numeric-method}
\title{A small test function}
\arguments{
  \item{x}{that's right, it's called x}

  \item{...}{some more stuff}
}
\value{
  the matrix minus 1

  a vector plus 1
}
\description{
  This function tests roxygen2
}

Раздел \ использование не найден...

0 ответов

Другие вопросы по тегам