【问题标题】:Minimum requirements for R package submissionR包提交的最低要求
【发布时间】:2013-08-27 20:31:41
【问题描述】:

我是 R 包提交的新手。我编写了一个程序,使用 R 中的基本函数来操作系统发育树数据。我依赖于 APE 包。经过将近一年的工作,现在是我提交包的时候了,除非需要,否则我几乎没有时间将其重写为 S3/4 样式。

目前它非常基础,有 30 多个功能,并且有一个驱动程序类。包提交有很多行话,所以很难理解谷歌的结果。我将不胜感激。

我的功能非常基本。例如,getRoot 获取当前树的根(APE phylo 对象),getAncestor 获取当前节点的祖先:

getRoot <- function(cur_Tree){
    return(length(cur_Tree$tip.label)+1)
}

getAncestor <- function(cur_Node, cur_Tree){
    ...
return(ancestor)
}
  1. 这样可以吗,还是我必须做其他事情才能提交包?稍后(在接下来的几个月内)我将有时间将这些功能转换为 S3/4,但目前最重要的是在 CRAN 上实现它。

  2. 小插图是否需要用 Latex 编写,还是我可以不用用 word 编写所有要求? (我相信我看过一个用 word 写的小插图 -> pdf)

  3. 还有其他建议/链接吗?

另外,我认为 R 开发团队在使用 R 和维护包库方面做得非常出色。我的目的不是偷工减料……只是我有一个用 R 编写的完整程序,我想提交它。此外,虽然 github 是托管代码的绝佳资源,但我的主要目标是将包提交给 CRAN。

谢谢!

【问题讨论】:

  • 为什么尽快将您的包裹放在 CRAN 上是最重要的?我觉得这种冲动令人不安,这背后是否有隐藏的议程?
  • 没有阴谋或隐藏的议程让我的包裹尽快在 CRAN 上......我知道我的帖子以某种方式暗示了这一点。我的包对科学有贡献,并且针对 R 语言背景很少的用户。这就是为什么我有一个使用我的函数的驱动程序类。至少使用 CRAN,安装很容易,其他需要它的科学家也可以找到该软件包。
  • 很公平 :) 只是想知道
  • 无论如何,有一些提示:i) 你不必有一个小插图; ii) CRAN 没有人会检查您的代码的质量或相关性; iii) 一个关键要求是您的包成功通过R CMD check -- as-cran 并且版权信息正确且符合CRAN rules

标签: r package cran


【解决方案1】:

要在 CRAN 上获得程序,主要问题是:

  • 有一个包结构(不仅仅是一堆 .R 文件)
  • 通过 R CMD 检查 -- as-cran

提示: R 包 devtools 对开发包有很大帮助。

R CMD check 的通过包含了很多东西。就像拥有文档一样,...

实际上第一个检查也不仅仅是 R CMD 检查。 有人会简单地检查一下包裹。

我记得我被要求在我的描述...文件中写“时间序列”而不是时间序列。

但总的来说,除了形式问题外,CRAN 的政策并不太严格。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2015-04-10
    • 2012-09-14
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多