Объекты ошибок в \usage без \alias в объекте документации из R CMD Check

Я написал небольшой пакет для собственного использования, и с помощью devtools все прошло очень хорошо. Однако я попытался запустить на нем R CMD Check и получил ряд ошибок, по-видимому, потому, что в моем использовании и примерах используются функции из базы R, которых нет в моем пакете, например, вот моя минимальная функция и документация roxygen

#' Function to Sort a dataframe with a given list of columns
#' Cribbed from Spector, P. (2008). "Data Manipulation with R", UseR! Springer. Pg78
#' @param df Dataframe to be sorted
#' @param ... list of columns to sort on
#' @return A sorted dataframe
#' @author "Paul Hurley"
#' @export
#' @usage with(dataframe,sortframe(dataframe,column1, column2, column3))
#' @examples with(iris,sortframe(iris,Sepal.Length,Sepal.Width,Petal.Length))
sortframe<-function(df,...){df[do.call(order,list(...)),]}

и R CMD Check дает

Undocumented arguments in documentation object 'sortframe'
  'dataframe' 'sortframe(dataframe, column1, column2, column3)'
Documented arguments not in \usage in documentation object 'sortframe':
  'df' '...'
Objects in \usage without \alias in documentation object 'sortframe':
  'with'

Есть ли способ сообщить R CMD Check/roxygen2, что эти функции описаны в базе?


person PaulHurleyuk    schedule 05.03.2013    source источник
comment
В моем случае я удалил @name, после чего ошибка исчезла. github.com/r-lib/roxygen2/issues/695   -  person Camford Oxbridge    schedule 17.03.2020


Ответы (1)


Вы не должны включать тег @usage. Roxygen выведет это из вашего кода. ваш @usage действительно пример. R жалуется, потому что вы ссылаетесь на объекты, которых вообще нет в определении вашей функции. @usage, если вы настаиваете на том, чтобы добавить его самостоятельно, следует ссылаться только на sortframe, df и .... Поскольку у вас уже есть @example, вы можете опустить тег @usage.

person BrodieG    schedule 29.07.2014