在R CMD Check的文档对象中没有\ alias的\ usage中的错误对象

Question

我已经为自己使用了一个小包装,使用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检查给出

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这些函数是用base描述的？

Answer 1

您不应该包含@usage标签。Roxygen 将从您的代码中推断出它。你@usage确实是一个例子。R 正在抱怨，因为您引用的对象根本不在您的函数定义中。 @usage，如果你坚持自己放进去，应该只引用sortframe、、、df和...。由于您已经有一个@example，因此您应该可以省略该@usage标签。