ITADN
nf-core/scdownstream
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

nf-core/scdownstream

Open in GitHub Codespaces GitHub Actions CI Status GitHub Actions Linting StatusAWS CICite with Zenodo nf-test

Nextflow nf-core template version run with conda run with docker run with singularity Launch on Seqera Platform

Get help on SlackFollow on BlueskyFollow on MastodonWatch on YouTube

简介

nf-core/scdownstream 是一个生物信息学流程,可用于处理已量化的单细胞 RNA-seq 数据。 它接受 samplesheet 以及 H5AD-、SingleCellExperiment/Seurat- 或 CSV 文件作为输入,并执行质量控制、整合、降维和聚类。 该流程生成一个整合后的 H5AD 和 SingleCellExperiment 文件以及一份详尽的 QC 报告。

该流程基于以下流程(按字母顺序)的学习成果和实现:

nf-core/scdownstream

带有船形图标的步骤尚未实现。对于其他步骤,流水线使用以下工具:

  1. Per-sample preprocessing
    1. Convert all RDS files to H5AD format
    2. Create filtered matrix (if not provided)
    3. Present QC for raw counts (MultiQC)
    4. Remove ambient RNA
    5. Apply user-defined QC filters (can be defined per sample in the samplesheet)
    6. Doublet detection (Majority vote possible)
    7. Cell cycle scoring (Tirosh et al. 2015)
  2. Sample aggregation
    1. Merge into a single H5AD file
    2. Present QC for merged counts (MultiQC)
    3. Integration
  3. Cell type annotation
  4. Clustering and dimensionality reduction
    1. Leiden clustering
    2. UMAP
    3. t-SNE (optional via --tsne)
  5. Create Quarto and (MultiQC) reports

用法

[!NOTE] 如果你是 Nextflow 和 nf-core 的新手,请参阅此页面了解如何设置 Nextflow。在运行工作流处理实际数据之前,请确保使用 -profile test 测试你的设置

[!NOTE] 如果你对术语 filteredunfiltered 感到困惑,请查阅各自的 documentation

首先,准备一个包含输入数据的 samplesheet,其格式如下:

sample,unfiltered
sample1,/absolute/path/to/sample1.h5ad
sample2,/absolute/path/to/sample3.h5
sample3,relative/path/to/sample2.rds
sample4,/absolute/path/to/sample3.csv

每个条目代表一个 H5AD、H5、RDS 或 CSV 文件。 RDS 文件可以包含任何能够使用 Seurat as.SingleCellExperiment 函数转换为 SingleCellExperiment 的对象。 CSV 文件应包含一个矩阵,其中基因作为列,细胞作为行。第一列应包含细胞名称/条形码。

-->

现在,你可以使用以下命令运行流水线:

nextflow run nf-core/scdownstream \
   -profile <docker/singularity/.../institute> \
   --input samplesheet.csv \
   --outdir <OUTDIR>

[!WARNING] 请通过 CLI 或 Nextflow -params-file 选项提供流水线参数。包括通过 -c Nextflow 选项提供的自定义配置文件在内的配置文件可用于提供除 参数 之外的任何配置;请参阅 docs.

有关更多详细信息和进一步的功能,请参阅 usage documentationparameter documentation.

Pipeline output

要查看使用完整规模数据集运行的示例测试运行的结果,请参阅 nf-core 网站流水线页面上的 results 选项卡。 有关输出文件和报告的更多详细信息,请参阅 output documentation.

Credits

nf-core/scdownstream 最初由 Nico Trummer 编写。

我们感谢以下人员在本流水线的开发过程中提供的广泛协助(按字母顺序排列):

Contributions and Support

如果您想为本流水线做出贡献,请参阅 contributing guidelines.

如需更多信息或帮助,请随时通过 Slack #scdownstream channel 与我们联系(您可以使用 this invite 加入)。

Citations

该流水线所用工具的详尽参考文献列表可在 CITATIONS.md 文件中找到。

您可以按以下方式引用 nf-core 出版物:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.