在Roxygen中缺少名称

Question

我有关于R6Class的文档：

#' Root component that don't have parent,
#'
#' It should not be used directly, only using \code{\link{pkg::component}} function.
#'
#' @name BaseComponent
#' @importFrom R6 R6Class
#' @docType class

#' @keywords components, architecture, structure

当使用roxygen时出现警告:

警告：[c:\projects\pkg\R\components.R:1] @title 缺少名称

我不知道为什么它显示第一行，我的代码不在第一行。

添加@title并没有改变任何东西，我仍然收到这个警告。

- jcubic

---

我有同样的问题。然而，我的文件末尾没有不寻常的注释，因此提供的答案对我来说无法解决这个问题。我有很多文件，都遵循相同的注释模式，但没有一个会引发这种警告。这让我疯了... - HolgerBarlt

@HolgerBarlt，我不确定是否理解您的意思。您说他们没有发出此警告。如果您确实遇到了此错误，请检查是否缺少其中一个注释中的“@title”。还要检查是否有R6类，因为它们的处理方式不同。如果您仍然收到警告，则可能应该提出另一个问题，因为在这里可能没有人会给您答案，而且已经有一个被接受的答案。 - jcubic

如果有其他人遇到了这个问题，可能只需要休息一下...我之所以会得到这个错误，是因为我没有存储函数名称。 我需要用 function_name<-function(x) 替换 function(x){}。 - mattador

Answer 1

警告信息不太清楚，文件的最后一行是这个：

#' init extend on base battery component
BaseComponent$extend <- make.extend(BaseComponent)

替换 #' 为 ## 解决了问题。

- jcubic

Answer 2

我曾经也遇到过这个问题。它是由于在同一个文件中的包函数中以下代码行引起的：

utils::globalVariables(c("."))

由于警告“没有全局变量的可见绑定”，我使用了以下代码：

Which I had used because of the warning no visible binding for global variable '.'

将该行移动到我的 R 文件夹中的单独文件后，我不再收到该消息。

- LMc

Answer 3

在我的情况下，这个警告是因为在 @example 部分出现了非 ASCII 字符。

#' @examples
#' \dontrun{
#' find_address(state = "Bayern",
#'              org = "Universität",  <-- the "ä" is the causing the warning
#'              page_size = 10)
#' }

roxygenise现在使用示例参数org = "Hochschule"非常好。

- Stefan Jelkovich