内容

1贡献的指导方针

我们欢迎对新数据集的贡献或建议HDCytoData包中。合适的数据集是任何高维细胞术数据集,它可以:(i)用于基准测试,例如包含某种地面真相或已知信号(例如模拟数据中的已知地面真相,或实验数据中的已知生物学结果),和/或(ii)用于其他活动,如教学、示例和教程。

下面,我们总结了将新数据集贡献给HDCytoData包中。有关如何使用Bioconductor的更多细节ExperimentHub资源和创造ExperimentHub软件包,请参阅ExperimentHub插图可从Bioconductor

1.1打开GitHub问题

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

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

1.2准备目标文件

如果贡献被批准,则每个数据集都需要以下内容:

  1. 格式化SummarizedExperiment而且flowSet对象,包含表达值的表以及用户完全理解数据集所需的所有行、列和其他元数据(例如,样本id、组id、患者id、集群标签、插入标签、通道名称、蛋白质标记名称、蛋白质标记类等)。注意,表达值应该是原始值(未转换)。

    对象应保存为.rda带有文件名的文件dataset_name_SE.rda而且dataset_name_flowSet.rda(dataset_name是新数据集的名称;如。Levine_32dim_SE.rda而且Levine_32dim_flowSet.rda).

    对象结构的一个示例是,加载一个现有数据集并检查SummarizedExperiment而且flowSet对象:

library(HDCytoData) #示例:SummarizedExperiment d_SE <- Levine_32dim_SE() d_SE length(assays(d_SE)) dim(d_SE) head(assay(d_SE)) rowData(d_SE) colData(d_SE) metadata(d_SE) #示例:flowSet d_flowSet <- Levine_32dim_flowSet() d_flowSet length(d_flowSet) fsApply(d_flowSet, dim) head(exprs(d_flowSet[[1]]) parameters(d_flowSet[[1]])@data colnames(d_flowSet) description(d_flowSet[[1]])
  1. 一个可复制的R脚本,显示如何格式化SummarizedExperiment而且flowSet对象是从原始数据文件(.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。理查德·道金斯(见GitHub更多例子)。

  3. 中描述数据集的元数据ExperimentHub数据库,将保存在文件中本月/脚本/ make-metadata。R.例如,请参阅此文件中现有数据集的元数据。

有关如何为存储在上的数据集构造文件的详细信息ExperimentHub,见标题为“创建一个实验程序包”的小插图Bioconductor页面。

1.3创建拉请求

生成了上面描述的所有部分之后,创建的分支HDCytoDataGitHub存储库,添加文件(除了.rda文件),并发送一个拉请求。请确保文件在正确的目录中,并且包通过了所有通常的Bioconductor和CRAN检查。

1.4请联系Bioconductor维护人员上传.rda文件

经谘询HDCytoData维护人员,您将需要联系BioconductorExperimentHub维护人员上传.rda文件。的ExperimentHub维护人员将手动将它们添加到ExperimentHub的“创建一个ExperimentHub包”小插图中所描述的Bioconductor页面。的任何未来更新(例如错误修复).rda文件将需要以同样的方式手动添加,因此请仔细检查对象。

2致谢

贡献者的名字将被添加到贡献者的DESCRIPTION文件中的字段HDCytoData包才能承认贡献。

3.行为准则

本项目是按照国家标准发布的贡献者契约行为准则.通过对本项目的贡献,您同意遵守其条款。任何有关行为准则的问题都可以通过电子邮件联系包维护人员来报告。