如何将r脚本放入包中

2023年3月17日 211次阅读

我正在编写我的第一个R包,并使用roxygen2和添加的数据集进行了成功的构建.

但是,我还想提供一个示例脚本,我将如何使用r包中的函数.但我不知道该把它放在哪里.

假设我创建了MyPackage.我已将我的函数脚本放在/ R文件夹中.比方说我有：

foo1.R
foo2.R
foo3.R

在某个地方,我还想在我的工作流程中添加一个脚本.假设我有一个文件MyWorkflow.R：

library(MyPackage)
load(file='inData.R') # Loads indata variables A, B and C
X=foo1(A)
Y=foo2(X,B)
Z=foo3(Y,C)

我可以这样做吗？如果是的话,我该把它放在哪里？这是一个好的程序 – 或者通常不赞成？

任何帮助或想法都表示赞赏.
谢谢.
卡尔

编辑：

我查看了demo /和exec /上的链接,但是没有理解exec /文件夹的内容.如果您能澄清/举例说明/指出……的良好用途,我将感激不尽

如果我理解正确,我不是在寻找示例或演示/,因为如果没有用户调整(例如提供输入数据或路径),脚本不一定是可执行的.我“只是”想要添加一个示例脚本,显示我如何使用这些函数.

我意识到我应该深入了解小插曲的世界,但很难找到这样做的时间/魅力/能量.

我还看到了inst /文件夹.你能不能对这些选项的不同用途有所了解,或暗示他们使用它们的好例子(我经常发现的例子比阅读高于我的水平的解释性文字更具信息性 – 我经常感觉像是一个狗看着吊扇;)

将信息添加到GitHub README.感谢好建议！

最佳答案 您可以将它放在demo /或exec /中,具体取决于脚本的格式.有关详细信息,请参见 here.我会提到工作流程以及它在README中的位置,如果你在Github上托管代码,你可以创建一个wiki来描述工作流程并将脚本放在那里.这与nrussell在上面的评论中提到的类似.

点赞