问题标签 [roxygen]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
r - 使用 \code{\link[package] 记录 a 时，请避免在 pdf 中无处链接
当我在 R 中编写函数文档并引用我使用的外部包 \code{\link[package]{function}}时，它对?交互式 R 中的函数非常有用。
但后来我的 pdf 文件链接了“函数”的文本，链接只是转到我的目录。如何关闭 pdf 的这些链接？
r - 记录从 roxygen2 中的超类继承的插槽
我正在尝试在 roxygen2 中记录我的 S4 课程。我有一个超类 FacebookGenericCollection，其中包含一些我仔细记录的插槽和一些扩展这些插槽的子类。
这是子类的示例代码：
但是当我构建 Rd 时，只记录了“限制”插槽，而所有从 FacebookGenericCollection-class 继承（并记录在）的插槽都没有记录。
我正在寻找类似于我用于函数的@inheritParams 的东西。
我试过@import FacebookGenericCollection 但没有效果。
任何想法？
r - 使用 roxygen 的内联包概述文档
我想这是我在文档中一直忽略的一件简单的事情，但我似乎无法弄清楚如何让包级文档在 R 中工作。我不是指函数或特定于类的文档，而是键入时获得的文档，例如 ?stats。
我遵循了我在网上找到的一般说明，创建了一个保存为 .R 的 sckeleton 文档文件。.R 文件与包脚本一起复制，但帮助文档不会被制作成 .Rd 文件（除非我添加了一个也以包命名的函数定义）。
我尝试过的一个例子：
出于某种原因，我很难找到如何设置通用包文档的好例子。我已经编写了很多函数帮助文件，并且我知道我的包帮助文件正在被 roxygen 找到，但不清楚为什么我不能从中生成 .Rd。
r - 必须构建和重新加载 roxygen 语法才能上传到文档
每次我想查看通过添加新roxygen注释生成的新文档时，而不是仅仅重建文档（Ctrl + Shift + D），我必须将Build & Reload新添加的内容显示在文档中。
仅重建文档时（Ctrl + Shift + D），我仍然会在添加更改之前看到旧文档...
我怀疑这是导致这种情况的设置。可能是什么原因以及如何解决？
r - Roxygen 导入/依赖的最佳实践？
我正在编写一个用于访问私有 API 的小型便利包，并且正在使用httr函数来执行请求。我还使用 Roxygen 来处理文档等。我正在导入httr这样的函数：
但是，当您尝试在没有预加载包的情况下运行包时，我会收到命名空间错误：
我通常会尊重Hadley在这类事情上的专业知识，但这是否是使用该Depends领域以及/而不是使用该领域的好案例Imports？
编辑：我的 NAMESPACE 由 Roxygen 生成。
编辑：我的说明文件。
roxygen2 - roxygen2 文档字符串，用于覆盖基类的引用类
我有一个看起来像这样的抽象基类：
以及扩展此类的以下类：
我跑之后
然后我得到两个 man 文件，但是在第二个类的 man 文件中，覆盖类的文档字符串没有通过——我得到了基类的文档字符串。我做错了什么还是 roxygen2 的错误？
还有没有更好的方法来做到这一点？我希望能够使用多行文档字符串。
r - R：roxygen2，导入的包不出现在命名空间
我的项目中有一个文件：import_packages.r，其中包含以下内容：
当我这样做时，devtools:document()这些包没有显示在 NAMESPACE 文件中，实际上它们也没有导入。难道我做错了什么？
r - Roxygen2 没有找到所有导出的 S3 方法，但抱怨 @S3method 被贬低
我有一些带有 S3 类的 R 代码，其中一些方法能够处理多个类。我试图向上游类用户隐藏该细节。一个简化的示例如下所示（使用类 2p、3p、3m）：
我的问题是，roxygen2 没有正确地将 bar.3m 识别为 S3 方法。如果我明确说@S3method bar.3m roxygen2 警告我“@S3method 已弃用。请改用@export。” 如何让 roxygen2 理解 bar.3m 是 S3 方法？注意：真正的功能不是微不足道的。
r - Roxygen 真的可以像 Doxygen 为 C++ 做的那样记录 R 脚本（不是包）吗？
Roxygen 的灵感来自 C、C++ 程序员使用的 Doxygen 文档系统。我用过 Doxygen，我发现只要你有 doxygen 注释，就可以很容易地记录任何程序。它还为函数和类生成调用图。我认为 roxygen 会以同样的方式工作，但是当我搜索 roxygen 帮助时，我只能找到记录 R 包的解决方案。
我已经检查了 Hadley Wickham 的在线roxygen2 帮助，但这并没有描述任何关于 R 脚本文档的内容。
我的脚本有时会变成 500-1000 行，并且有几个功能，我总是在注释中记录这些功能。我想用图形即图表生成 PDF 或 HTML 文档。Roxygen 是否能够制作调用图和记录独立的 R 脚本？
r - 如何使用 roxygen 记录包含同名函数的 R 包？
我正在学习使用氧气。我看到rd vignette提倡使用“_PACKAGE”来表示我正在创建包文档，并说“如果已经有一个名为 pkgname() 的函数，这也有效。”
我还看到了R packages book的使用方法
指定了@docType 和@name，但是当我尝试使用任何一种方法制作玩具示例时，它都无法按我的预期工作。
作为一个玩具示例，我想制作一个包含“hello()”函数的“hello”包。
我希望获得有关我的 hello包的文档
或者类似的东西
我希望获得有关包含的 hello函数的文档
我哪里错了？- 使用 roxygen 实现，我尝试查询文档的方式，不正确的期望，还是其他什么？
以下是有关我的玩具示例的一些详细信息：
你好/描述文件：
你好/R/你好.R
这样，在我运行之后document()，就会生成 hello/man/hello.Rd。它包含我为 hello 包和 hello() 函数编写的描述的组合。?hello并且?hello()都返回那个 .Rd 文件。
这是 .Rd 的样子：