r - 是否可以从另一个包中的函数 @inheritParams ?

标签 r documentation roxygen2

我为一种晦涩的 TSV 格式编写了一个导入程序,我想对其进行打包和记录:https://github.com/katrinleinweber/MWX-import/commits/package

导入函数传递重命名的 skip_lines utils::read.table 的参数所以我想“通过”后者的文档 skip进入我的 .Rd .但是,尝试一些符号,如 @inheritParams utils::read.table skip总是导致 Warning: Failed to find topic […] .

在阅读 http://r-pkgs.had.co.nz/man.html 后,我不清楚是否真的可以从另一个包的函数继承单个特定参数。和 https://blog.rstudio.org/2017/02/01/roxygen2-6-0-0/ .

是否可以?如果是,感谢您的任何提示!

最佳答案

如果您使用 @inheritParams utils::read.table ,然后是函数中与 utils::read.table 中的参数匹配的任何参数将被继承(前提是它们尚未明确记录)。因此,如果您使用 skip,这将涵盖您的用例而不是 skip_lines .

但是,当您的参数名称不匹配时,我认为不可能继承参数的文档。

关于r - 是否可以从另一个包中的函数 @inheritParams ?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/42703052/

相关文章:

kotlin - 使用 KDoc 记录 Ktor 路由

r - 如何使用 Roxygen2 在没有通用别名的情况下添加特定于类的别名?

r - 创建具有依赖项的 R 包

r - 如何将趋势线添加到两个变量,r 中的两个 y 轴图?

Visual Studio 上的 R 统计语言

r - 如何合并动物园对象但使用滞后和变化的列?

r - Sparklyr copy_to 失败

c - xv6 中 open() 定义的位置

.NET xml 文档 - 继承文档

r - 使用 roxygen2 处理示例文件 : backslashes are duplicated (\dontrun becomes\\dontrun)