此页面概述了提交过程以及要遵循的关键原则。也可以看看包装指南适用于包装的特定准则和要求以及生物导体新包装提bob体育取款很慢交跟踪器。
提交包裹生物导体包应该:
rtracklayer :: import()
用于输入常见基因组文件)。[[回到顶部这是给予的
生物导体软件包由三种主要软件包类型广泛定义:软件,,,,实验数据, 和注解。
用户贡献的大多数软件包都是软件包。软件包提供了算法(例如统计分析),对资源(例如BiomArt或NCBI)或可视化(例如火山图,路径图)的实现。可以在此处找到用于创建软件包的说明:包装指南。
注释软件包是类似数据库的软件包,可提供链接标识符(例如Entrez基因名称或Affymetrix探针ID)的信息,以与其他信息(例如,染色体位置,基因本体学类别)。还鼓励利用AnnotationHub存储和访问大型原始数据文件及其转换为标准R格式。可以在此处找到用于在AnnotationHub中添加数据并设计注释软件包的说明:创建AnnotationHub软件包。
实验数据包提供通常通过软件包使用的数据集来说明特定分析。这些软件包包含来自实验,教学课程或出版物的精选数据,在大多数情况下,包含一个数据集。还鼓励使用实验室来存储并访问较大的数据文件。实验室也对托管相关数据集的集合特别有用。可以在此处找到用于在实验室中添加数据并设计实验数据包的说明:创建实验室包。
看包装指南有关包装格式和语法的详细信息。
[[回到顶部这是给予的
接受包裹生物导体带来正在进行的软件包维护职责。包装作者的期望是:
遵循生物导体准则
遵循生物导体的释放周期
每年4月和十月左右有两个版本。这发布时间表将指示每个版本的时间表和截止日期。发行周期通常会产生两个版本的包装“ Devel”和“发行”。熟悉这些分支概念很重要。一旦您的包裹被接受,它最初将位于“ Devel”分支机构中。当前的Devel分支成为下一个版本。期望大多数用户使用发布分支,因此直到下一个版本,他们将无法立即访问您的包裹。错误修复可以在两个分支中修复,而新功能只能添加到“ Devel”分支中。
使用版本控件维护软件包
意识到生物导体,与Cran不同,在GIT版本控制下维护所有包装源代码。这意味着您使用git。如果您的包裹被接受,您将收到具有典型GIT操作的说明(请参阅After接受部分)。由于R和/或其他软件包依赖项的潜在变化,因此需要通过软件发布周期进行包装维护,包括对软件和文档的提示更新。
订阅Bioc-devel邮件列表
Bioconductor团队通过此列表与开发人员进行沟通。bob电竞体育官网这也是将更改与其他开发人员传达的好渠道。bob电竞体育官网及时解决生物导体团队的要求,可以确保您的包裹可以通过生物导体可用。
支持网站是用户的官方支持渠道。用户甚至开发人员可能会在此平台bob电竞体育官网上询问有关您的包裹的问题。确保在支持网站配置文件的“观察标签”部分中包括您维护的所有软件包。这将使您通知您有关您的软件包的任何问题。重要的是要迅速回答错误报告和问题生物导体支持网站发布或直接发送给开发人员。bob电竞体育官网一些维护者更喜欢指出BugReports:
在包裹的描述文件中字段。该字段指示一个特定的网页,用于提交错误报告和问题。
[[回到顶部这是给予的
通过在生物导体贡献存储库,遵循准则的readme.md
文件。假设您的包裹在GitHub存储库在默认分支下,将链接添加到您要打开的问题中。您不能指定任何替代分支;使用默认分支。默认分支必须仅包含软件包代码。其他应用程序(GitHub操作,DevTool等)的任何文件或目录都应在其他分支中。
[[回到顶部这是给予的
实验数据包包含特定于特定分析或实验的数据。它们通常伴随一个软件包,用于示例和小插曲,并且通常不定期更新。如果您需要用于工作流程或示例的一般数据子集,请首先检查可用文件的AnnotationHub资源(例如BAM,Fasta,Bigwig等)或实验Hub,以了解已包含在生物导体。如果没有当前的文件或数据集适当考虑使用的相关实验数据包实验室。
如果您为软件包有关联的数据包,请执行不是在我们的跟踪器存储库中创建一个单独的问题。相反,请将数据包存储库添加到与软件包相同的问题中。执行此操作的过程已记录这里。
[[回到顶部这是给予的
注释软件包包含来自公共源的轻微或未策划的数据,并随着每个数据进行更新生物导体释放(每6个月)。它们是一个或多个生物的一般注释来源,并且不是特定实验的特定来源。如果可能的话,他们应该支持选择()
AnnotationDbi的接口。
注释软件包应该不是发布到跟踪器存储库。而是将电子邮件发送给packages@bioconductor.org描述了建议的注释包和有关发送套件的何处的指令。只要可能的注释软件包应使用AnnotationHub用于管理文件。
[[回到顶部这是给予的
最初将新软件包标记为“ 1。等待审核'。一个生物导体团队成员将简要介绍您的包裹,以确保其旨在生物导体。适当的软件包将被重新标记为2。正在进行的审查和审阅者将自动分配。您分配的审阅者将解决您的疑虑,并通过审核过程为您提供帮助。整个审查过程通常需要2到5周。
该包将提交给生物导体构建系统(BBS)。该系统将从Github检查您的包裹。然后将运行R CMD构建
创建源代码,小插图和人页的“ tarball”。它将运行R CMD检查
在Tarball上,以确保包装符合标准r编程最佳实践。生物导体选择使用自定义R CMD检查
环境;看R CMD检查环境更多细节。最后,构建系统将运行Bioccheckgitclone()
和Bioccheck()
确保包裹符合生物导体生物检查标准。系统将使用“ Devel”版本的生物导体,在三个平台上(Linux,Mac OS X和Windows)。完成这些步骤后,将把构建报告的链接附加到新的软件包问题上。通过在您自己的计算机上运行这些检查,避免惊喜生物导体,在提交包裹之前。
如果构建报告指示问题,请修改软件包并提交对GitHub存储库的默认分支的更改。如果有您不理解的问题,请在Bioc-devel邮件列表。
要触发新的构建,请在您的提交中包括一个版本颠簸,例如版本:0.99.0
至版本:0.99.1
。预先释放版本利用0.99.z
格式。当接受并发布时,您的软件包的版本编号将自动增加到1.0.0。
一旦您的包裹构建和检查没有错误或(可避免的)警告,生物导体团队成员将对您的包裹进行技术审查。其他生物导体bob电竞体育官网鼓励具有域专业知识的开发人员和用户提供其他社区评论。审阅者将为您创建的问题添加评论。
回应审阅者提出的问题。你必须回应主要审稿人,并强烈鼓励考虑社区评论。通常,您的响应将涉及代码修改;将这些提交给GITHUB存储库的默认分支,以触发后续构建。当您解决所有问题时,请在步骤2中创建的问题中添加评论以解释您的回复。
审阅者将评估您的回答,也许建议进一步修改或澄清。然后,审阅者将接受您的包裹以包含在内生物导体或拒绝它。标签‘2。正在进行的审查将被‘3a取代。接受的”或3B。拒绝了。
如果您的包裹被接受,它将添加到生物导体的GIT存储库和夜间的“ Devel”构建。存储库“ Devel”分支机构中的所有软件包均在大约4月和10月的每六个月“发布”一次。
审核过程完成后,您创建的问题将关闭。包装的所有更新将通过生物导体git服务器。
[[回到顶部这是给予的
接受包装后:
Biocmanager :: install()
。bob电竞体育官网开发人员应该碰到z
每次提交对包装的更改时,其版本编号的一部分,遵循版本编号准则。如果开bob电竞体育官网发人员不碰到版本,则对其包装进行的更改不要传播到生物导体网站和软件包存储库。
[[回到顶部这是给予的
我们渴望提高生物导体软件并将在包装开发人员要求时提供额外的支持。bob电竞体育官网援助示例包括使用适当的S4结构,有效实施的具体指南,有关代码结构指南以及包装文档和结构的批判性评估。使用Bioc-devel邮件列表或电子邮件packages@bioconductor.org获得额外的支持。
[[回到顶部这是给予的