内容

1贡献的指导方针

我们欢迎新数据集包含的贡献或建议HDCytoData包中。适合任何高维血细胞计数数据集,数据集:(i)可用于基准测试的目的,例如包含某种形式的地面真理或已知的信号(如已知地面实况模拟数据,或一个已知生物导致实验数据),和/或(ii)等其他活动是有用的教学例子,和教程。

下面,我们总结的关键步骤提供一个新的数据集HDCytoData包中。如何使用Bioconductor的更多细节ExperimentHub资源和创造ExperimentHub包,看到ExperimentHub小插曲可以从Bioconductor

1.1GitHub开放问题

打开一个GitHub问题(或拉的请求,如果你已经有了所有可用文件)的HDCytoDataGitHub页面联系维护人员和讨论新数据集的适用性。

使用GitHub(而不是电子邮件)确保有一个公共记录的贡献。如果你不熟悉GitHub,请通过电子邮件联系维护人员寻求帮助。

1.2准备对象文件

如果批准的贡献,以下是需要为每个数据集:

  1. 格式化SummarizedExperimentflowSet表达对象包含表(s)值和所有的行,列和其他元数据所需的用户完全理解数据集(如样本id、组id、病人id、集群标签,在标签,频道名称、蛋白质标记名称,蛋白质标记类,等等)注意表达式值应该是原始值(不改变)。

    应该保存的对象.rda文件名的文件dataset_name_SE.rdadataset_name_flowSet.rda(dataset_name新数据集的名称;如。Levine_32dim_SE.rdaLevine_32dim_flowSet.rda)。

    对象结构的一个例子,加载一个现有的数据集和检查的各种元素SummarizedExperimentflowSet对象:

库(HDCytoData) #例子:SummarizedExperiment d_SE <——Levine_32dim_SE () d_SE长度(化验(d_SE))的负责人(d_SE)构成了rowData (d_SE)(化验(d_SE)) colData (d_SE)元数据(d_SE) #例子:flowSet d_flowSet < - Levine_32dim_flowSet () d_flowSet长度(d_flowSet) fsApply (d_flowSet dim)头(exprs (d_flowSet[[1]]))参数(d_flowSet [[1]]) @ data colnames (d_flowSet)描述(d_flowSet [[1]])
# #警告:”。当地的弃用。# #使用“关键字”。# #看到帮助(弃用)
  1. 可再生的R脚本显示格式化的SummarizedExperimentflowSet对象从最初的原始数据生成的文件(.fcs文件)。脚本应该命名make-data-dataset-name.R(如。make-data-Levine-32dim.R),将被保存本月/脚本目录的源代码HDCytoData包用于再现性。

    例如,看到一个现有的数据集的脚本,例如。本月/脚本/ make-data-Levine-32dim.R(见GitHub更多的例子)。

  2. 全面的文档描述数据集,它可以用于什么,和对象结构。这应该是格式化的.Rd文件,保存在男人。目录的源代码HDCytoData包中。(注意,Roxygen不能用于ExperimentHub包,所以.Rd文件需要手工编写。)

    例如,看到一个现有的数据集的帮助文件,例如Levine_32dim ?或源代码人/ Levine_32dim_SE.Rd(见GitHub更多的例子)。

  3. 元数据描述的数据集ExperimentHub数据库,这将被保存在文件中本月/脚本/ make-metadata.R。有关示例,请参见现有数据集的元数据在这个文件中。

更多细节关于如何结构的文件存储在一个数据集ExperimentHub看到vignette题为“创建一个ExperimentHub包”Bioconductor页面。

1.3创建拉请求

一旦所有上述部分已经生成,创建一个叉的HDCytoData(除了GitHub库,添加文件.rda文件),并发送一个请求。请确保正确的文件目录,包通过所有常见的Bioconductor和凹口检查。

1.4联系Bioconductor维护者上传.rda文件

在协商HDCytoData维护人员,然后,您将需要联系BioconductorExperimentHub维护人员上传的.rda文件。的ExperimentHub维护人员会手工将它们添加到ExperimentHub数据库,如所描述的“创建一个ExperimentHub包”上的装饰图案Bioconductor页面。注意,任何未来的更新(如bug修复).rda文件需要手动添加同样的,所以请仔细检查对象。

2承认的贡献

贡献者的名字将被添加到贡献者字段的描述文件HDCytoData包,以识别的贡献。

3的行为准则

这个项目是按照发布贡献者契约的行为准则。为这个项目作出贡献,您同意遵守其条款。任何问题关于报告的行为准则可能会通过电子邮件联系包维护者。