使用 roxygen2 导出变体函数

Question

当我使用 @describeIn 或 @rdname 来记录函数的变体时，该变体不会被导出。我可以在 roxygen 骨架中放置一个标签来更改它，还是我需要直接进入 NAMESPACE？

#' 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 之后的文本行。请注意运行 roxygen:

时给出的有关 "invalid path" 的消息

> 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

Use roxygen2 to export a variant function