R roxygen2：不在列表中显示功能

Question

这个问题是关于使用 roxygen2 的，而不是关于如何覆盖函数的。

我正在将 roxygen2 用于CRAN软件包，并且正在尝试实现以下目标：

有一个名为my.function的函数，我想将其函数名称替换为my_function。

我想逐步执行此操作-因此一段时间内，两个函数名称都将可用。

第一步，我要具备以下条件：

1. 如果用户明确调用?my.function，他们将来到my.function函数的文档（或my_function的文档）

2. 但是，如果用户调用help(package="myPackage") my.function，则不会出现在功能列表中

背景是，如果用户明确搜索旧函数名称，他们仍然会找到它。但是，如果他们只是通常在搜索可用的功能（因为它们是软件包的新功能），那么它们只会获得新名称。

我该怎么做？

我正在试验以下氧气标签的组合：

@noRd
@alias
@describeIn
@rdname

但是我无法达到我想要的结果。我是在专门询问roxgen2文档部分，而不是在一般情况下覆盖R中的函数。

Answer 1

您可以通过在R packages的对象文档部分中添加@keywords internal到roxygen注释来禁止将函数列在软件包手册中，但是如上所述Hong Ooi提出的正确方法可能是弃用my.function（请参见R packages的发布软件包部分）。