什么是好的R包名?

时间:2014-06-13 09:06:00

标签: r package

我正在搜索一个好名字以寻找我想发送给CRAN的R包。我没有找到关于R包namming的良好实践的任何信息。 is a post关于如何分析包名称,但它没有回答我的问题。还有the alphabetical list of CRAN packages但它只显示存在的东西,而不是实践中的好东西。

选项包括:

  • 尺寸:保持名称短(8个字符或更少),然后使用library(thepack)轻松调用,但可能不会像the_next_package那样使用;
  • 骆驼风格:使用骆驼风格(例如 thePack)来分割单词,但是在调用时可能会让用户拼错它#39 ;区分大小写(library(thepack)不等于library(thePack));
  • 特殊字符:使用"。"等特殊字符。或" _"分开单词(例如 the_packthe.pack),但我发现它们不优雅
  • R字母:添加大写 R 以表示该R包(例如 RpacktheRpack)但我们遇到的问题与Camel Style相同。

这可能是一个微不足道的问题,但我认为包的名称很重要,因为它是包和用户之间的第一次交互。然后,当使用library()函数调用时,必须同时有意义,简洁且易于编写。

1 个答案:

答案 0 :(得分:24)

Writing R Extensions仅提供以下约束:

  

强制性“包”字段给出了包的名称。这应该只包含(ASCII)字母,数字和点,至少有两个字符,以字母开头而不是以点结尾。

请注意,不允许使用下划线字符_

您可以通过检查列表here来开始您的研究 - 特别是,很少的包名称包含点字符.

另外,请查看this SO question以获取一些有用的代码。更重要的是,@ agstudy提供了Hadley Wickham关于他最喜欢的包命名约定here的提示的链接。

顺便说一句,如果您打算将包裹提交给CRAN, 如果不合适,CRAN团队可能会建议更改名称。