使用roxygen2导出变量函数

Question

当我使用@describeIn或@rdname来记录函数的变体时，变量不会被导出。我可以在氧气骨架上放置一个标签来改变它，还是我需要直接进入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时给出的关于“无效路径”的消息：

> 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