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

Answer 1

您不应包含@usage标记。 Roxygen会从你的代码中推断它。你的@usage就是一个例子。 R抱怨是因为你指的是根本不在函数定义中的对象。 @usage，如果您坚持自己加入，请仅引用sortframe，df和...。由于您已经有@example，因此您应该可以省略@usage代码。

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

1 个答案: