MiXCR
Home - MiXCR
Analysis overview - MiXCR
Introduction of MiXCR
MiXCR是一款通用软件,用于快速准确地分析原始T细胞或B细胞受体序列数据。它适用于任何类型的测序数据:
- 带或不带UMI的批量曲目排序数据
- 单细胞测序数据,包括但不限于10x基因组学方案
- RNA-Seq或任何其他类型的片段/霰弹枪数据,这些数据可能只包含目标序列的一小部分
- 以及包含TCR或BCR的任何其他类型的测序数据
Installation / Download
Requirements
- Any OS with Java support (Linux, Windows, Mac OS X, etc..)
- Java 1.8 or higher
几种安装方式
- Using Homebrew on Mac OS X or Linux (linuxbrew)
Conda
Docker
Manual install (any OS)
Conda
- license key
conda install -c milaboratories mixcr
# Academic users can quickly get a license at
# https://licensing.milaboratories.com.
# 通过邮箱获得license key
mixcr activate-license
# 输入 key
Usage
MiXCR为许多可用的商业套件、数据类型和库准备协议提供了一个全面的内置预设列表。命令导出预设可以帮助理解预设的结构。
预设可用于使用analyze命令运行整个上游分析管道。例如
mixcr analyze <preset-name> \
sample_R1.fastq.gz \
sample_R2.fastq.gz \
sample_result
软件内置的 预设 模式
mix-in
MiXCR提供了一组混合选项,允许使用高级原语配置分析管道。
虽然预设已经决定了整个分析管道,但可以使用混合选项添加额外的配置。这些选项“混合”了额外的配置或修改了给定预设的预先配置。有一个内置的mixin列表,可以方便地根据特定需求调整任何管道。
某些预设要求用户指定混合项(标志)(如上述情况中的物种)。例如,让我们考虑一个通用的预设tcr扩增子,用于分析通用tcr扩增文库。它需要指定物种、起始材料类型(DNA或RNA)、3'-和5'-文库结构(V、J或C基因上的引物/适配器):
参数
$mixcr analyze -h
mixcr analyze [--help]
# analyze-specific options
[--no-reports]
[--no-json-reports]
[--output-not-used-reads]
[--use-local-temp]
[--threads <n>]
[--force-overwrite]
# mix-ins
[--add-step <step>]
[--remove-step <step>]
[--limit-input <n>]
[--species <species>]
[--library <library>]
[--split-by-sample]
[--dont-split-by-sample]
[--sample-table sample_table.tsv]
[--dna] [--rna]
[--floating-left-alignment-boundary [<anchor_point>]]
[--rigid-left-alignment-boundary [<anchor_point>]]
[--floating-right-alignment-boundary (<gene_type>|<anchor_point>)]
[--rigid-right-alignment-boundary [(<gene_type>|<anchor_point>)]]
[--tag-pattern <pattern>]
[--keep-non-CDR3-alignments] [--drop-non-CDR3-alignments]
[--assemble-clonotypes-by <gene_features>]
[--split-clones-by <gene_type>]... [--dont-split-clones-by <gene_type>]...
[--assemble-contigs-by <gene_features>]
[--impute-germline-on-export]
[--dont-impute-germline-on-export]
[--prepend-export-clones-field <field> [<param>...]]...
[--append-export-clones-field <field> [<param>...]]...
[--prepend-export-alignments-field <field> [<param>...]]...
[--append-export-alignments-field <field> [<param>...]]...
[--add-export-clone-table-splitting <(geneLabel|tag):key>]
[--reset-export-clone-table-splitting]
[--add-export-clone-grouping <(geneLabel|tag):key>]
[--reset-export-clone-grouping]
[-M <key=value>]...
# inputs and outputs
<preset_name>
([I1.fastq[.gz] [I2.fastq[.gz]]] R1.fastq[.gz] [R2.fastq[.gz]]
| file.(fasta|bam|sam))
output_prefi
Tutorial
使用数据集:
mixcr analyze generic-amplicon-with-umi \
--species hsa \
--rna \
--rigid-left-alignment-boundary \
--floating-right-alignment-boundary C \
--tag-pattern '^(R1:*)\^(UMI:N{12})' \
raw/SRR{{n}}_GSM4195461_TCR-seq_P15-T0-TIGIT_Homo_sapiens_OTHER_1.fastq.gz \
raw/SRR{{n}}_GSM4195461_TCR-seq_P15-T0-TIGIT_Homo_sapiens_OTHER_2.fastq.gz \
results/P15-T0-TIGIT