将函数参数文档与包数据集链接

时间:2019-05-08 15:56:34

标签: r devtools roxygen

我正在使用roxygen记录打包功能。一个参数dataset在函数中作了简短说明,例如

@params dataset is a dataframe to be processed. 

但是,为了更好地理解dataset是什么,我想将用户重定向到我的软件包example_dataset脚本中记录的data.R的文档。

对于常规功能,我可以通过\link{other_function}来实现。但是,对于数据集,\link{"example_dataset"}显然不是开箱即用的:

help(my_function)

,然后点击指向example_dataset的链接,将显示以下消息:

No help found for topic "example_sample_annotation" in any package.

是否可以将my_function的帮助页面与example_dataset链接?

0 个答案:

没有答案