来自另一个包中的函数的@inheritParams是否可能?

时间:2017-03-09 18:39:32

标签: 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和{{3}之后,我是否真的可以从其他软件包的功能中继承单个特定参数}。

有可能吗?如果是,请感谢任何提示!

1 个答案:

答案 0 :(得分:1)

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

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