Hata Nesneleri \ CM olmadan, nesne \ r \ r \ r \ r \ Nesneler \ r \ n \ r \ n \ r \ n \ z Nesneler nesnesinde

Question

Kendi kullanımım için küçük bir paket yazdım ve her şey çok iyi geçti. Ancak, R CMD Check çalıştırmayı denedim ve bir takım hatalar gördüm, çünkü kullanımım ve örneklerim paketimin içinde olmayan R tabanından fonksiyonlar kullanıyor, örneğin burada benim minimal fonksiyonum ve roxy dokümantasyonu

#' 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(...)),]} 

ve R CMD Kontrol/R CMD Kontrolü anlamanın bir yolu var mı

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' 

verir bu işlevler tabanında açıklanan olduğunu roxygen2?

Answer 1

@usage etiketini dahil etmemelisiniz. Roxygen bunu kodunuzdan çıkaracaktır. senin @usage gerçekten bir örnektir. R, şikayetçidir çünkü fonksiyon tanımınızda olmayan nesnelere atıfta bulunuyorsunuz. @usage, kendi kendine koymakta ısrar ederseniz, yalnızca sortframe, df ve ... referanslarına başvurmalısınız. Zaten bir @example olduğundan, @usage etiketini atlayabilmeniz gerekir.