使用roxygen2导出变量函数
当我使用使用roxygen2导出变量函数,r,roxygen2,package-development,R,Roxygen2,Package Development,当我使用@descripebein或@rdname记录函数的变体时,该变体不会被导出。我是否可以在roxygen骨架中放置一个标记来更改此设置,或者我是否需要直接进入名称空间 #' Title #' #' @return #' @export #' #' @examples foo <- function() { "foo" } #' @rdname foo A variant #' #' @export bar <- function() foo() #”标题 #' #“@
@descripebein
或@rdname
记录函数的变体时,该变体不会被导出。我是否可以在roxygen骨架中放置一个标记来更改此设置,或者我是否需要直接进入名称空间
#' Title
#'
#' @return
#' @export
#'
#' @examples
foo <- function() {
"foo"
}
#' @rdname foo A variant
#'
#' @export
bar <- function() foo()
#”标题
#'
#“@返回
#“@出口
#'
#“@示例
foo问题是@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
或者使用@descripbein
:
#' @describeIn foo A variant.
#' @export
您是否强烈反对在roxygen for bar中添加@export
?这就是foo代码中的@export为您所做的。对于别名函数也是如此,我试过了,因为这似乎是很自然的事情,但仍然没有导出。我的结论是我遗漏了一些语法上的细微差别。您是否使用devtools::document()
重新运行了roxygen。应该可以,对吧?应该可以。如果检查名称空间文件,是否已将其修改为包含bar?我只是想知道您是否更新了软件包,但忘记了构建/安装它,并尝试使用本地安装的软件包来测试它是否有效。