r语言 - 使用roxygen2导出一个变量函数

Question

当我使用@describeIn或@rdname来记录函数的变体时，该变体不会被导出。我是否可以在氧骨架中放置一个标记来改变这一点，或者我是否需要直接进入名称空间?

#' Title
#'
#' @return
#' @export
#'
#' @examples
foo <- function() {
  "foo"
}
#' @rdname foo A variant
#'
#' @export
bar <- function() foo()

当我附加这个包时，我可以调用foo很好，但试图调用bar导致Error: could not find function "bar"。

Answer 1

问题是@rdname foo之后的文本行。请注意运行氧分压时给出的"无效路径"消息:

> devtools::document()
Updating mypackage documentation
Loading mypackage
Writing NAMESPACE
Writing foo.Rd
Skipping invalid path:  foo A variant..Rd 

这个问题可以通过移除标签文本来解决:

#' @rdname foo
#' @export

或者使用@describeIn:

#' @describeIn foo A variant.
#' @export