R:构建包时发出警告

时间:2014-11-29 16:45:24

标签: r package

在我正在编写的包中,我对类的对象有一个“自定义”打印函数,比如“myclass”。

print.myclass <- { 
  # ... 
  # ...
}

在print.myclass.Rd文件中,我有类似的内容:

\name{print.myclass}
\alias{print.myclass}
\alias{print}
\title{Print method for objects of class \code{myclass}.}
\description{Display \code{myclass} objects in the console or in \emph{RStudio's Viewer}.}
\usage{
  \method{print}{myclass}(x, method, \dots)
  print(x, method="some.method", ...)
}

当我运行R CMD检查--as-cran时,我收到以下警告:

* checking for code/documentation mismatches ... WARNING Functions or methods
with usage in documentation object 'print.summarytools' but not in code:   
print

我必须尝试所有可能的反复试验组合,导入并删除它,但我正在寻找一堵墙。我甚至不确定“但不在代码中”是什么意思......我们是在谈论R脚本中的R代码,还是.Rd文件中的代码?

我希望有足够经验积极的人可以引导我走向光明。

THX

1 个答案:

答案 0 :(得分:1)

解决方案只是删除\用法部分中的第二行:

\usage{
  \method{print}{myclass}(x, method, \dots)
  print(x, method="some.method", ...)        <- culprit
}

要保留第二行中给出的额外信息位(method的默认值),这样可行:

\usage{
  \method{print}{myclass}(x, method="some.method", \dots)
}