使用函数包装器后，保持链接到帮助页面

Question

我不久前开始使用R编程，我对第三方功能的名称感到不安。是的，他们有文档，但有时函数的名称缩写为不可读性。

我想为每个函数编写一个函数包装器，该名称很容易被完全读取。我仍然希望能够呼叫帮助（即通过在RStudio中按F1）。

有什么办法吗？

Answer 1

我觉得你的痛苦，但我认为写包装通常不是一个好主意，因为对于任何人但你 ¹ 这将使代码不太可读，即使他们不熟悉原始库。首先，您的功能将完全无法搜索（在Google等上）。

此外，如评论所述，R不允许非打包函数携带文档。您需要生成自己的包装器包。然后，在包内，您可以按如下方式定义别名：

#' @importFrom original_package orig_fct1
readable_function1 = orig_fct1

#' @importFrom original_package orig_fct2
readable_function2 = orig_fct2

# … etc

也就是说，您不需要（并且不应该）生成包装函数;只定义别名就足够了。 @importFrom Roxygen指令导致文档从原始函数继承。

¹ 而“除了你之外的任何人”都会在几个月内包括你自己！