问题标签 [rd]

我需要为 .aef 文件扩展名开发一个编辑器。但是在做了很多谷歌搜索之后，我没有发现.aef 的架构是什么。我们如何读/写 .aef 文件。

任何帮助深表感谢

通常希望在 R 帮助文件中的“It's”中使用像弯撇号这样的语法字符。

使用常规单引号') 不是一个很好的解决方案，因为'它用于 roxygen 行开头 ( #') 和引用字符串（这会导致文本编辑器中的语法高亮中断（不在 .Rd 文件中）。

什么不起作用

1. 您不能只粘贴 unicode。
   • CRAN 不允许在包中使用任何非 ascii 字符以实现可移植性。
2. 您不能使用编码的 unicode，例如 \u2019
   • 这呈现为原始字符串。
3. 您不能使用 & 转义的 html 代码。
   • ’在帮助中呈现为原始代码:-(

那么：是否有在 Rd 文件中包含撇号的解决方案？

在努力用 roxygen2 记录 S4 类之后，我决定退后一步，使用package.skeleton、promptClass和promptMethod.

我的问题是R CMD check，尽管我认为我已经正确记录了它们，但它仍然对“未记录的代码对象”发出警告。

我现在拥有的文件是：

测试类.R：

testClass-class.Rd

和 testMethod.Rd

还有一个包文档文件，但我认为这里不相关。

R CMD check给出：

我已经查阅了这些部分，我从中得到的是我至少需要一个别名 to generic,signature-list-method，在这种情况下，alias{testMethod,testClass-method}它是通过我调用 promtMethod 自动放入文档文件中的（我已经从类中注释掉了） .Rd 文件，因为它在那里被复制）。

我需要在 .Rd 文件中进行哪些更改才能消除此警告？

我读过的

我已经阅读了这个 SO question 和相关答案，但我仍然有点不知道如何defunct在我的包中正确记录函数。

我试过的

• 我defunct通过调用替换了我的功能代码.Defunct("<pointer to a function to be used instead>", "<my package name>")
• 我删除了.Rd包含我的函数的旧文档的文件
• 我创建了mypackage-defunct.Rd一个别名指向我现在的defunct函数名称的文件
• 在mypackage-defunct.Rd我为我的旧函数创建了一个\usage条目并将函数参数替换为\dots（因为我认为不需要跟踪旧参数。我遵循了一些在base-defunct中所做的事情）

我有什么

运行时 RCMD CHECK我得到以下信息WARNING：

检查 Rd \usage 部分...警告文档对象'mypackage-defunct''...'中的未记录参数

具有 \usage 条目的函数需要具有适当的 \alias 条目，并记录其所有参数。\usage 条目必须对应于语法上有效的 R 代码。请参阅“编写 R 扩展”手册中的“编写 R 文档文件”一章。

我想拥有什么

我如何摆脱警告？我需要记录函数的参数defunct吗？额外问题：对于已失效的功能，推荐的方法是什么。我应该删除所有参数并用 替换它们...吗？查看base-defunct，我看到混合了具有正确参数名称的函数，.以及 ...参数和空参数列表。什么是“正确”的方式？

我正在使用 roxygen2 来记录我的 R 包中的对象，如书R 包中所述。我想在每个对象的文档页面的顶部（和底部）插入一些文本，例如“机密 - 请勿发布”。对于 HTML 文档页面，我可以使用 CSScontent属性，当然也可以插入一些 HTML。

那么如何修改从 roxygen2 渲染的文档页面的页面标题呢？目前我只对 HTML 文档页面感兴趣，而不是 PDF，因此使用 roxygen2 或 Rd 将一些任意 CSS 或 HTML 插入每个文档页面可能就足够了。那可能吗？

理想情况下，我想找到一个可以为整个包全局设置一次的选项，因为如果我必须将它单独添加到每个对象的文档中，我可能会错过一些。但如果我必须将它添加到每个对象，我可以忍受它。

我正在Card et al Medicare 数据上实施 RDDtools 包。我已经能够建立一个简单的参数回归。我现在想做的是在ageyrs. 我ageyrs作为协变量输入，但返回错误：

在文档中，它说我应该将协变量作为公式输入。有谁知道这个公式是什么？

我最近向 CRAN 提交了一个包，他们的一条评论是“请解开 Rd 文件中的所有示例，每个 Rd 文件可以在 5 秒内执行”。

我用 roxygen2 生成这些 rd 文件，所以我不确定打开所有示例的确切含义。他们都有一个不运行的论点，所以我不确定这是否是我必须删除的。下面是一些示例代码。

编辑：包裹进入了 CRAN，这意味着它通过了所有的测试和备注等。但是，我仍然得到了上面提到的评论。

我知道roxygen2::roxygenise()或可以使用甘蔗从.Rdevtools::document()文件生成.Rd文件。

例如，如果Test.R如下

那么 roxygen2::roxygenise()or的输出devtools::document()将是

但是，我对反之亦然感兴趣。我确实有.Rd，我想将其转换为.R文件。有什么想法吗！

我在项目文件夹中有函数和数据集的文档。在文档文件夹中，我有所有数据集的 .Rd 文件。我希望用户能够调用自定义帮助函数并在查看器中启动 .Rd 文件，就像从文件编辑器编译文件时自动完成的那样。是否有可能做到这一点？

假设

Roxygen2 使用启发式。如果句点前面的前缀已知（merge, cut），则该方法是 S3 方法，否则（slice），它是普通方法。

问题

这种启发式记录了吗？更重要的是，有没有办法避免它？我应该能够为函数名称编写任何未使用的标识符，而无需注意前缀，这也意味着未来将无法保证给定包的稳定性。我知道“S3 类没有正式定义”（下面引用的最后一个小插曲），但混淆有正式定义的内容似乎很荒谬。此外，任何将来为使用新包而对包进行的编辑都可能突然使现有 API 失效。

我试图通过NAMESPACE在生成文件后手动编辑文件来解决这个问题，但这有时会与包安装混淆（以我还不理解的方式）。以下实验是问题的设置。

实验

运行后devtools::create("MyPackage")，输入以下代码

在MyPackage/R/somefile.R.

现在运行devtools::document()（两次）。你会看到内容

已在文件中生成MyPackage/NAMESPACE。换言之，四个函数被假定为S3函数。

从页面

现在（大约从 2014 年开始？）#' @export在 S3 方法或普通方法之前编写就足够了，并且roxygen2会弄清楚它是什么。