一种对含有分子条码的测序数据进行去条码和纠错的软件包。
debarcer的Python项目详细描述
一种对含有分子条码的测序数据进行去条码和纠错的软件包。有关开始使用debarcer的信息,请参见Installation Guide。
注:自然协议中描述的Debarcer(v0.3.1)原始版本的存储库可以在 https://github.com/oicr-gsi/debarcer/releases/tag/v0.3.1
https://github.com/oicr-gsi/debarcer/tree/master-old
配置
示例配置文件在/debarcer/config/sample_config.ini中提供,示例prepfile在/debarcer/config/library_prep_types.ini中提供。期望多次使用的阈值和路径应存储在配置文件中。prepfile包含如何处理不同库prep的说明,例如:
; One library entry[LIBRARY_NAME]INPUT_READS=3OUTPUT_READS=2UMI_LOCS=2UMI_LENS=10SPACER=FALSE
- 输入读数:
- 未处理的fastq文件数(1-3)。
- 输出读数:
- 重新读取后的fastq文件数(1-2)。
- 乌米湖:
- 包含umi(1-3)的读取的逗号分隔索引。
- umi_镜头:
- 对应于umi-locs(1-100)的umi的逗号分隔长度。
- 间隔棒:
- 如果存在间隔,则为true,否则为false(true/false)。
- 垫片(可选):
- 间隔基序列([a,c,g,t]+)。
LIBRARY_NAME将是传递给debarcer.py的--prepname参数。
典型工作流程
## Preprocess some fastq files $ python debarcer.py preprocess -o /path/to/output_dir -r1 /path/to/read1.fastq -r2 /path/to/read2.fastq -prepname "prepname" -prepfile /path/to/library_prep_types.ini ## Align, sort, index ## ... ## produces: bam_file.bam, bam_file.bam.bai ## Error-correct and group UMIs into families $ python debarcer.py group -r chrN:posA-posB -c /path/to/config.ini -b /path/to/bam_file.bam -o /path/to/output_dir ## Perform base collapsing $ python debarcer.py collapse -o /path/to/output_dir -r chrN:posA-posB -b /path/to/bam_file.bam -u /path/to/umi_file.umis -c /path/to/config.ini ## Call variants of specified family sizes $ python debarcer.py call -o /path/to/output_dir -r chrN:posA-posB -cf /path/to/cons_file.cons -f 1,2,5 -c path/to/config.ini
依赖关系
debarcer使用python 3.6.4进行了测试,并依赖于pysam和pandas包。见requirements.txt。