錯誤對象在\用法中沒有\別名在R CMD的文檔對象中檢查

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檢查/ roxygen2，這些功能在基地描述？

Answer 1

您不應該包含@usage標記。 Roxygen會從你的代碼中推斷出它。您的@usage就是一個例子。 R抱怨是因爲你指的是根本不在你的函數定義中的對象。 @usage，如果你堅持把它放在你自己，應該只參考sortframe,df，和...。由於您已有@example，因此您應該可以省略@usage標記。