13

私は自分で使用する小さなパッケージを作成しましたが、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'

これらの関数が base に記述されていることを R CMD Check/roxygen2 に伝える方法はありますか?

4

1 に答える 1

3

タグを含めるべきではありません@usage。Roxygen はコードからそれを推測します。あなた@usageは本当に例です。関数定義にまったく含まれていないオブジェクトを参照しているため、R は不平を言っています。 @usage、自分で入れたいと主張する場合はsortframe、 、df、およびのみを参照する必要があり...ます。はすでにあるので、タグ@exampleを省略できるはずです。@usage

于 2014-07-29T23:28:39.810 に答える