Объекты Error в \use без\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, что эти функции описаны в базе?
Ответы
Ответ 1
Вы не должны включать тег @usage
. Roxygen выведет его из вашего кода. ваш @usage
- действительно пример. R жалуется, потому что вы ссылаетесь на объекты, которые вообще не входят в определение вашей функции. @usage
, если вы настаиваете на том, чтобы поместить его в себя, следует указывать только sortframe
, df
и ...
. Поскольку у вас уже есть @example
, вы можете опустить тег @usage
.