如何在Github上托管R包的示例数据

时间:2019-04-18 08:43:29

标签: r github

我正在尝试GitHub,并创建了一个小包供同事使用。他们使用devtools软件包和install_github()函数直接在R中安装它。我还提供了一些示例数据和一个R-Markdown文件,该文件显示了软件包and can be published via GitHub Pages中所有功能的用法。

我想知道使其他人能够使用此示例数据来学习软件包的最佳实践是什么。

我可以想到两种不同的选择:

  1. 将数据托管在安装目录之外的单独目录中,并告诉人们手动下载数据,或在示例脚本的开头使用类似download.file()中的R函数的名称进行下载可以打包为.zip的所有数据。
  2. 将数据作为软件包安装的一部分,但是这将要求数据相当小,这在我的特定情况下比较困难(数据为10MB)。

理想情况下,R文档(.Rd文件夹中的man文件中的示例)也可以使用与markdown文件中的示例相同的示例。同样在这种情况下,选项(2)似乎是有利的。

任何人都可以给我一些建议吗?如果有的话,那是最好的“行业标准”。

0 个答案:

没有答案