R对象文档：作为第一项的包文档

我有一个R包，我想在创建的PDF手册的第一项中显示关于该包的一般信息

我使用

roxygen2

（7.0.2版）创建文档，并遵循给出的说明。 当我创建文档时，手册中出现的项目都是按字母顺序排列的，包括一般文档的项目。但是，当然，我想把一般文档放在最上面

似乎将包文档项放在第一位必须以某种方式起作用，因为它在中起作用

我的设置：我使用RStudio创建了一个包“TestPackage”，其中包含一个“hello.R”文件：

当我跑步时

R CMD Rd2pdf TestPackage

我得到了一份PDF手册，第一项是“hello”，然后是“TestPackage”

---

如何确保包的项目在第一位？

为了确保包文档条目在手册中位于第一位，您需要将其

名称
设置为
-package
（将
替换为包的名称）。在这里，您可以通过改变

#' @name TestPackage

到

为什么会这样？好的，当您遇到R包开发中的一些奇怪的角落时，您可以做的最好的事情就是咨询。在这里，我们想看看（R中的文档文件的格式是
Rd
；
roxygen
为您创建
Rd
文件）。具体而言，在第2.1.1节中，我们看到

\名称{name}

name typically101是包含文档的Rd文件的基本名称。。。程序包手册中的条目将按\name条目的字母102顺序排列

脚注102告诉我们

在当前区域设置中，对LaTeX特殊字符进行特殊处理，并将任何“pkgname package”主题移至列表顶部

因此，您必须将
名称
作为
pkgname包
的
Rd
文件移动到手册的顶部。
您可以尝试将
#name TestPackage
行更改为
#name TestPackage
吗？疯狂！谢谢，这个有用！如果你把它作为答案贴出来，我可以接受。虽然这样做的工作，我也会感谢一些背景资料，为什么这项工作，如果你能给一些。你引用的说明有点旧。请看这里：我认为如果您使用
roxygen2
中的“Rd（文档）标签”vignette中描述的
\u包
sentinel，这种情况会自动发生。您可以详细说明一下吗？我怎么能用这个“哨兵”？
R CMD Rd2pdf TestPackage

#' @name TestPackage

#' @name TestPackage-package