r - 使用 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".

score 1 · Accepted Answer

问题是之后的文本行@rdname foo。请注意运行 roxygen 时给出的有关“无效路径”的消息：

> 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

1 回答 1