如何将R脚本放入包中

Car*_*ius 6 r package

我正在编写我的第一个R包,并使用roxygen2和添加的数据集成功建立了文档。

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

假设我已经创建了MyPackage。我已将功能脚本放在/R文件夹中。假设我有:

foo1.R
foo2.R
foo3.R
Run Code Online (Sandbox Code Playgroud)

我也想在工作流程中放一个脚本。假设我有一个文件,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)
Run Code Online (Sandbox Code Playgroud)

我可以这样做吗?如果是这样,我应该放在哪里?这是可以的程序-还是普遍不赞成?

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

编辑:

我查看了demo/和上的链接exec/,但不了解exec/文件夹内容。如果您能阐明/举例说明/指出对...的正确使用,将不胜感激。

如果我理解正确,那么我不是在寻找exampleor demo/,因为脚本在没有用户调整的情况下不一定可以执行(例如,提供输入数据或路径)。我只是想添加一个示例脚本来显示我如何使用这些功能。

我意识到我可能应该潜入的世界vignettes,但很难找到这样做的时间/精力/精力。

我也看到有 inst/文件夹。您能否阐明这些选项的不同用法,或者暗示一些使用它们的好例子(我经常发现这些例子比阅读超出我的水平的解释性文字更有启发性-我经常感到自己像一个狗看着吊扇;)

将信息添加到GitHub README。谢谢你的建议!

Chr*_*s C 2

您可以将其放入demo/exec/根据脚本的格式。请参阅此处了解更多详细信息。无论如何,我都会在 README 中提及工作流程及其所在位置,如果您将代码托管在 Github 上,则可以创建一个wiki来描述工作流程并将脚本放在那里。这与恩罗塞尔在上面的评论中提到的类似。