为什么 @family 标签在 roxygen2 中的单词之间添加点?
Why does the @family tag add dots between words in roxygen2?
我正在编写一个 R 包并使用 roxygen2 创建文档。我使用 RStudio 中的 Build & Reload 按钮构建包和文档。根据 RStudio 的输出,它使用 devtools::document(roclets=c('rd', 'namespace'))
来编译文档。
我想使用 @family
标签来 link 文档中的许多函数,这就是我的问题所在。这一行
#' @family functions returning some object
在.rd文件中转换为如下
\seealso{
Other functions.returning.some.object: \code{\link{test2}}
}
我不想要单词之间的点。我有一个较旧的包,但不会发生这种情况,即使我在与编译新包完全相同的设置中重新编译文档也是如此。我看不出这个旧包和我的新尝试之间没有根本区别。
我写了一个很简单的测试包,这里也出现了这个问题。它包含一个 R 文件 (testpackage.R
):
#' Test function 1
#'
#' @param x a number
#'
#' @family functions returning some object
#' @family aggregate functions
#'
#' @export
test1 <- function(x) {
x*x
}
#' Test function 2
#'
#' @param x a number
#'
#' @family functions returning some object
#' @family aggregate functions
#'
#' @export
test2 <- function(x) {
x*x*x
}
描述文件是
Package: testpackage
Type: Package
Title: Package for testing purposes
Version: 1.0
Date: 2015-05-21
Author: Me
Maintainer: Me <me@somewhere.com>
Description: Package for testing purposes
License: GPL-3
名称空间由 roxygen 生成。对于文档 test1.Rd
,我得到:
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/testpackage.R
\name{test1}
\alias{test1}
\title{Test function 1}
\usage{
test1(x)
}
\arguments{
\item{x}{a number}
}
\description{
Test function 1
}
\seealso{
Other aggregate.functions: \code{\link{test2}}
Other functions.returning.some.object: \code{\link{test2}}
}
在 \seealso
部分添加不需要的点。显然,@family
标签中的字数似乎无关紧要。我试过用引号、各种括号等将文本括起来,但没有任何积极效果。当然,我可以编辑 Rd 文件,但这会错过使用 roxygen2 的意义。
R CMD check
在 testpackage
.
上运行时没有警告或错误
为什么会出现这些点?我怎样才能摆脱它们?
我升级到 Roxygen 5.0.0(现在是 CRAN 版本),发现问题消失了。
这是 roxygen2
中的错误 -- 我已经记录了一个问题 here。它实际上是使用 unstack()
的结果,它执行一些不需要的转换。
我正在编写一个 R 包并使用 roxygen2 创建文档。我使用 RStudio 中的 Build & Reload 按钮构建包和文档。根据 RStudio 的输出,它使用 devtools::document(roclets=c('rd', 'namespace'))
来编译文档。
我想使用 @family
标签来 link 文档中的许多函数,这就是我的问题所在。这一行
#' @family functions returning some object
在.rd文件中转换为如下
\seealso{
Other functions.returning.some.object: \code{\link{test2}}
}
我不想要单词之间的点。我有一个较旧的包,但不会发生这种情况,即使我在与编译新包完全相同的设置中重新编译文档也是如此。我看不出这个旧包和我的新尝试之间没有根本区别。
我写了一个很简单的测试包,这里也出现了这个问题。它包含一个 R 文件 (testpackage.R
):
#' Test function 1
#'
#' @param x a number
#'
#' @family functions returning some object
#' @family aggregate functions
#'
#' @export
test1 <- function(x) {
x*x
}
#' Test function 2
#'
#' @param x a number
#'
#' @family functions returning some object
#' @family aggregate functions
#'
#' @export
test2 <- function(x) {
x*x*x
}
描述文件是
Package: testpackage
Type: Package
Title: Package for testing purposes
Version: 1.0
Date: 2015-05-21
Author: Me
Maintainer: Me <me@somewhere.com>
Description: Package for testing purposes
License: GPL-3
名称空间由 roxygen 生成。对于文档 test1.Rd
,我得到:
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/testpackage.R
\name{test1}
\alias{test1}
\title{Test function 1}
\usage{
test1(x)
}
\arguments{
\item{x}{a number}
}
\description{
Test function 1
}
\seealso{
Other aggregate.functions: \code{\link{test2}}
Other functions.returning.some.object: \code{\link{test2}}
}
在 \seealso
部分添加不需要的点。显然,@family
标签中的字数似乎无关紧要。我试过用引号、各种括号等将文本括起来,但没有任何积极效果。当然,我可以编辑 Rd 文件,但这会错过使用 roxygen2 的意义。
R CMD check
在 testpackage
.
为什么会出现这些点?我怎样才能摆脱它们?
我升级到 Roxygen 5.0.0(现在是 CRAN 版本),发现问题消失了。
这是 roxygen2
中的错误 -- 我已经记录了一个问题 here。它实际上是使用 unstack()
的结果,它执行一些不需要的转换。