我该如何处理“帮手”？ R 包中的函数？

Question

背景

我编写了一个 R 包，现在一位合作者（最近刚接触 R 的 CS 毕业生）正在编辑和重构代码。在此过程中，他将我的功能划分为更小、更通用的功能。

他所做的事情是有道理的，但是当我开始使用 package.sculpture() 时，每个函数都有一个文件。现在，他添加了主要函数所依赖的函数，但这在函数本身之外的用途可能有限。

他建议将所有函数放入一个文件中，但我反对，因为当我们处理不同的文件时，更容易进行版本控制。

从那时起，我开始使用 roxygen 来记录文本中的每个函数。

问题

处理函数的推荐方法是什么：显然辅助函数应该与主函数保持一致，但是我需要在多大程度上记录辅助函数？

评论中的 @export 建议很有帮助，但我很好奇其他人如何组织他们的代码。

Answer 1

我在两个条件下剪切我的函数：

1. 当它提高主函数代码的可读性时，和/或
2. 当它避免复制粘贴代码时，例如，如果在同一函数中多次使用相同的代码。

我确实在主函数的文件中包含了所谓的辅助函数，但前提是这些辅助函数未在任何其他函数中使用。实际上，我认为它们嵌套在主函数中。我确实理解您关于版本控制的论点，但是更改辅助函数归结为更改主函数的性能，因此我认为将它们保留在同一个文件中没有问题。

一些辅助函数可能会在不同的其他函数中使用，然后我将它们保存在自己的文件中。我经常导出这些函数，因为用户可能会对它们感兴趣。将此与 lm 和底层 lm.fit 进行比较，其中高级用户可以充分利用 lm.fit 来加速代码等。

我使用相当多的软件包（并源自 Linux）中使用的命名约定，在每个“隐藏”函数前面加一个点。因此，这使得

.helper.function <- function(x, ...){
    ... some code ...
}

main.function <- function(x, ...){
    ...some code, including .helper.function(y, ...)
}

我明确 @export 所有需要导出的函数，而不是辅助函数。判断最终用户是否对某个功能感兴趣并不总是那么容易，但在大多数情况下这是非常清楚的。

举个例子：我认为用几行代码来切断 NA 行是一个辅助函数。一个更复杂的函数，用于将数据集转换为我导出和记录的正确格式。

青年MMV