MIT License

项目介绍

nf-core/oncoanalyser 是一个托管在 GitHub 上的开源项目,主要使用 Nextflow 编写,采用 MIT License 许可证,目前获得 112 个 Star、32 次 Fork。

仓库全名
nf-core/oncoanalyser
开源许可证
MIT License
Star 数
112
Fork 数
32
未关闭 Issue
22

README 摘要

Introduction nf-core/oncoanalyser is a Nextflow pipeline for the comprehensive analysis of cancer DNA and RNA sequencing data using the WiGiTS toolkit from the Hartwig Medical Foundation. The pipeline supports a wide range of experimental setups: FASTQ, BAM, and / or CRAM input files WGS (whole genome sequencing), WTS (whole transcriptome sequencing), and targeted / panel sequencing 1 Paired tumor / normal and…

完整内容见 GitHub 原始 README 或本页 。

常见问题

oncoanalyser 用什么语言开发?

主要使用 Nextflow 编写,采用 MIT License 许可证,目前有 112 个 Star。

oncoanalyser 可以免费商用吗?

仓库采用 MIT License 许可证,可免费使用与修改,商业使用请遵守许可证条款(例如保留版权声明与许可声明)。

如何获取 oncoanalyser 的源码?

可以直接克隆仓库:git clone https://github.com/nf-core/oncoanalyser.git;安装与运行步骤见仓库 README。

oncoanalyser 最近还在维护吗?

仓库最近一次更新为 6月15日,当前有 22 个未关闭 Issue;Star 数为 112,可作为社区活跃度的参考。

关于

GitHub 原始描述(英文)

A comprehensive cancer DNA/RNA analysis and reporting pipeline

描述取自 GitHub 官方 API,保持仓库作者书写的原文。

简要分析

热度分
288
价值分
86
活跃状态
活跃

语言占比

Dockerfile
Groovy
HTML
Nextflow
Shell

Release

README

nf-core/oncoanalyser

Open in GitHub Codespaces GitHub Actions CI Status GitHub Actions Linting Status AWS CI Cite 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 Slack Follow on Bluesky Follow on Mastodon Watch on YouTube

Introduction

nf-core/oncoanalyser is a Nextflow pipeline for the comprehensive analysis of cancer DNA and RNA sequencing data using the WiGiTS toolkit from the Hartwig Medical Foundation. The pipeline supports a wide range of experimental setups:

  • FASTQ, BAM, and / or CRAM input files
  • WGS (whole genome sequencing), WTS (whole transcriptome sequencing), and targeted / panel sequencing1
  • Paired tumor / normal and tumor-only samples, and support for donor samples for further normal subtraction
  • Purity estimate for longitudinal samples using genomic features of the primary sample from the same patient2
  • UMI (unique molecular identifier) processing supported for DNA sequencing data
  • Most GRCh37 and GRCh38 reference genome builds

1 built-in support for the TSO500 panel with other panels and exomes requiring creation of custom panel reference data
2 for example a primary WGS tissue biopsy and longitudinal low-pass WGS ccfDNA sample taken from the same patient

Pipeline overview

The pipeline mainly uses tools from WiGiTS, as well as some other external tools. There are several workflows available in oncoanalyser and the tool information below primarily relates to the wgts and targeted analysis modes.

Note 注意

Due to the limitations of panel data, certain tools (indicated with * below) do not run in targeted mode.

For the purity_estimate mode, several of the above tools are run with adjusted configuration in addition to the following.

  • Tumor fraction estimation: WISP

Usage

Note 注意

If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.

Create a samplesheet with your inputs (WGS/WTS BAMs in this example):

group_id,subject_id,sample_id,sample_type,sequence_type,filetype,filepath
PATIENT1_WGTS,PATIENT1,PATIENT1-N,normal,dna,bam,/path/to/PATIENT1-N.dna.bam
PATIENT1_WGTS,PATIENT1,PATIENT1-T,tumor,dna,bam,/path/to/PATIENT1-T.dna.bam
PATIENT1_WGTS,PATIENT1,PATIENT1-T-RNA,tumor,rna,bam,/path/to/PATIENT1-T.rna.bam

Launch oncoanalyser:

nextflow run nf-core/oncoanalyser \
    -profile <docker/singularity/.../institute> \
    -revision 3.0.0 \
    --mode <wgts/targeted> \
    --genome <GRCh37_hmf/GRCh38_hmf> \
    --input samplesheet.csv \
    --outdir output/
Warning 警告

Please provide pipeline parameters via the CLI or Nextflow -params-file option. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters; see docs.

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Pipeline output

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

Version information

Extended support

As oncoanalyser is used in clinical settings and subject to accreditation standards in some instances, there is a need for long-term stability and reliability for feature releases in order to meet operational requirements. This is accomplished through long-term support of several nominated feature releases, which all receive bug fixes and security fixes during the period of extended support.

Each release that is given extended support is allocated a separate long-lived git branch with the ‘stable’ prefix, e.g. stable/1.2.x, stable/1.5.x. Feature development otherwise occurs on the dev branch with stable releases pushed to master.

Versions nominated to have current long-term support:

  • TBD

Known issues

Please refer to this page for details regarding any known issues.

Credits

The oncoanalyser pipeline was written and is maintained by Stephen Watts (@scwatts) from the Genomics Platform Group at the University of Melbourne Centre for Cancer Research.

We thank the following organisations and people for their extensive assistance in the development of this pipeline, listed in alphabetical order:

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don’t hesitate to get in touch on the Slack #oncoanalyser channel (you can join with this invite).

Citations

You can cite the oncoanalyser Zenodo record for a specific version using the following DOI: 10.5281/zenodo.15189386

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

You can cite the nf-core publication as follows:

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.

评论

暂无评论