免疫组库分析软件MiXCR的安装和使用

免疫组库分析软件MiXCR的安装和使用

安装

conda安装

conda install -c milaboratories mixcr

普通安装

在Mac OS X上使用Homebrew或者在Linux系统上使用linuxbrew安装

brew install milaboratory/all/mixcr

将已经安装的MiXCR更新到最新版本

brew update brew upgrade mixcr

手动安装

1. 解开压缩包

2. 将解压缩生成的文件夹添加到环境变量中

• 添加mixcr脚本的符号链接到bin文件夹

• 或者在执行脚本中指定MiXCR的全路径来直接使用

快速使用

综述

典型的MiXCR工作流程主要由三个部分构成：

• 将测序结果比对到T细胞或B细胞受体的V、D、J、C基因参考序列上

• 利用前一步骤获得的比对结果拼接clonotypes（为了提取特定的基因区域信息，比如CDR3）

• 输出比对结果（exportAlignments模块）或者clones信息（exportClones模块），生成可读文件

MiXCR的assemble模块有几种不同的拼接方法可以选择：

• 拼接完整的TCR或者IG受体clonotype序列

• 对于, 工作流程可能包括以下两部分：

– 将有重叠区域的序列片段拼接成相对较长的包含CDR3区域的contigs

– : 估算测序和比对质量较好但长度较短的TCR比对序列的germline序列

为了简化输入命令，MiXCR提供了命令模块，打包了整个分析流程

MiXCR支持一下若干种数据类型：fasta，fastq，，paired-end fastq和。作为每一步骤的输出结果，MiXCR生成包含各种信息的二进制压缩文件（比对生成alignments，拼接生成clones）。利用exportAlignments和exportClones命令模块，每一个二进制文件都可以转化成tab分割的可读文本文件。

实例

默认流程 / multiplex-PCR

利用命令分析multiplex-PCR扩增的TCR/BCR基因DNA片段

mixcr analyze amplicon --species hs --starting-material dna --5-end v-primers --3-end j-primers --adapters adapters-present --receptor-type IGH input_ input_ analysis

只有一个参数修改为非默认值（--receptor-type IGH），这个参数的改变可以让MiXCR 调用针对B细胞优化的比对模块并且只输出IGH序列。其实这个参数是可以缺省的，缺省状态下MiXCR会调用默认的比对模块并输出样本中所有的TCR/BCR序列。 生成的文件（）是一个tab分隔的表格，包含CDR3序列拼接的所有clonotypes（克隆丰度，CDR3序列， VDJ基因等）。

详细流程

利用analyze amplicon模块与执行下面的命令是等价的

> mixcr align -s hs -p kAligner2 input_ input_ ... Building alignments > mixcr assemble ... Assembling clones > mixcr exportClones --chains IGH ... Exporting clones to tab-delimited file

基于5’RACE扩增实验的数据分析

考虑基于5’RACE（一个read覆盖CDR3区域和临近序列，另一个read覆盖V基因的5’UTR和下游序列）实验准备的IGH基因cDNA文库双端测序的数据处理流程，全部分析流程可以通过命令实现

> mixcr analyze amplicon --species hs --starting-material rna --5-end v-primers --3-end j-primers --adapters adapters-present input_ input_ analysis

结果文件（ypes..txt）包含详细的clonotypes信息。

详细流程

利用analyze amplicon模块将执行下面的流程：

1. 把原始序列比对到IGH基因的VDJ基因序列片段上

> mixcr align -s hs -atureToAlign=VTranscript --report input_ input_

用来比对V基因的非默认基因特征（-atureToAlign=VTranscript）同时利用了两个reads的信息，为了让MiXCR利用CDR3反向read比对V基因的5’UTRS和部分5’端编码区域。MiXCR还会生成report文件（通过可选参数--report指定），其中包含的具体运行统计信息如下

可以利用exportAlignments命令将比对生成的二进制结果（）转化为可读的文本文件。

2. 拼接clonotypes

> mixcr assemble --report -a

这一步骤会校正PCR和测序错误并建立clonotypes，默认情况下clonotypes会拼接CDR3序列；可以通过设置assemble模块的参数来制定其他的基因区域（参考），可选的report文件包含各种调试信息

3. 将包含clones列表的二进制文件（）导出为可读的文本文件

> mixcr exportClones --chains TRA > mixcr exportClones --chains TRB > ...

导出的clones信息如下表所示

Clone

count

4369

3477

…

Clone

fraction

2.9E-3

2.5E-3

…

… V hits

… IGHV4-39*00(1388)

… IGHV4-34*00(1944)

… …

J hits

IGHJ6

*00(131)

IGHJ4

*00(153)

…

AA. seq.

seq. CDR3 CDR3

TGTGTGAG… CVRHKPM…

…

…

TGTGCGAT… CAIWDVGL… …

… … …

导出的各种选项详见文档，上述的所有步骤都可以根据特定研究的分析流程进行个性化设置。

高质量全长IG免疫组库分析

> mixcr analyze amplicon --species hs --starting-material rna --5-end v-primers --3-end j-primers --adapters adapters-present --receptor-type BCR --region-of-interest VDJRegion --only-productive --align "-OreadsLayout=Collinear" --assemble "-OseparateByC=true" --assemble "-OqualityAggregationType=Average" --assemble "-icMutationProbability=1E-5" --assemble "-OmaxBadPointsPercent=0" input_ input_ analysis

这一步骤会生成以下结果文件（，和），其中包括详细的clonotypes信息。这里我们要强调几个可选参数：

•

•

•

•

•

--receptor-type BCR 需要MiXCR调用B细胞优化的比对模块（等同于对模块使用-p kAligner2参数）并且只输出IG序列。

region-of-interest VDJRegion 对模块使用-OassemblingFeatures=VDJRegion参数

--only-production 在输出的clonotypes中过滤掉out-of-frame和stop codon

--align 在过程中设置其他的参数

--assemble 在过程中设置其他参数

详细流程

使用命令等同于执行下面的MiXCR步骤

1. 合并双端reads并比对：MiXCR的align模块可以合并双端reads并比对到参考的V/D/J和C基因上，我们推荐使用处理IG数据

> mixcr align -p kaligner2 -s hs -r -OreadsLayout=Collinear -atureToAlign=VTranscript read_ read_

选项-s用来指定物种（e.g. homo sapiens - hsa, mus musculus - mmu），参数-OreadsLayout 用来设定reads方向（Collinear, Opposite, Unknown）。这里需要注意的是，经过MiGEC分析的双端reads方向是Collinear。 除了KAligner2，也可以使用默认的MiXCR比对模块，只是也许会忽略一些亚变异类型，这些变异类型是由V基因片段的若干核苷酸插入形成的。

2. 拼接clones

> mixcr assemble -r -OassemblingFeatures=VDJRegion -OseparateByC=true -OqualityAggregationType=Average -icMutationProbability=1E-5 -OmaxBadPointsPercent=0

-OseparateByC=true 把clones按照不同的抗体亚型分类 -OcloneClusteringParameters=null 关闭基于频率的PCR错误校正 根据数据质量，可以通过设置-ObadQualityThreshold参数来调节输入数据的阈值来优化clonotypes的提取。

3. 输出clones结果

> mixcr exportClones -c IGH -o -t

选项-o和-t用于过滤包含out-of-frame和stop codon的clonotypes，-c指定哪条链的数据应该被提取（e.g. IGH, IGL）。

RNA-Seq数据分析

MiXCR可以用于提取RNA-Seq数据中TCR和BCR的CDR3组库，提取效率取决于样本红T/B细胞的丰度和测序长度。推荐2x150bp或者2x100bp的双端测序方法。不过在双端2x50bp的RNA-Seq数据（比如肿瘤样本中），主要clonotypes信息也可以被。 单一命令可以完成分析

> mixcr analyze shotgun --species hs --starting-material rna --only-productive input_ input_ analysis

生成的结果文件（, 等）包含clonotypes的详细信息。

详细流程

1. 比对reads

> mixcr align -s hs -p rna-seq -OallowPartialAlignments=true data_ data_

所有mixcr align的参数都可以在这里使用（比如-s来指定物种）： -OallowPartialAlignments=true选项保留部分比对结果用于后续的assemblePartial模块

2. 拼接部分reads

> mixcr assemblePartial

为了获得包含CDR3全长序列的拼接reads，建议使用迭代mixcr的assemblePartial模块多次迭代拼接结果。多次迭代需要-p参数，根据我们的经验，两次迭代后结果最优

> mixcr assemblePartial alignmentsRescued_ > mixcr assemblePartial alignmentsRescued_ alignmentsRescued_

3. 利用已有V和J基因延长TCR比对结果，基于germline序列不全覆盖度不完全的CDR3s

> mixcr extendAlignments alignmentsRescued_ alignmentsRescued_2_

4. 拼接clones

> mixcr assemble alignmentsRescued_2_

所有mixcr assemble的参数都可以在这里使用：

•

•

对于低质量数据，建议降低输入质量阈值（e.g. -ObadQualityThreshold=15）

为了克隆丰度与错误校正算法相结合，增加下面的选项：-OaddReadsCountOnClustering=true

5. 导出clones

> mixcr exportClones -c TRA -o -t

可以指定导出感兴趣的免疫受体链（-c TRA 或者 -c TRB等），也可以去除包含out-of-frame（选项-o）和stop codon的突变体（选项-t）。

参数解读

模块名称

analyze

align

assemble

assembleContigs

assemblePartial

extend

exportAlignments

exportAlignmentsPretty

exportClones

exportClonesPretty

exportReadsForClones

模块功能

对指定输入文件执行MiXCR整套分析流程

对输入测序reads生成V/D/J/C基因比对序列

拼接clones

拼接全长序列

拼接部分比对reads 生成更长的序列

用germline序列预测比对序列或clones

将V/D/J/C比对结果导出为tab分隔文件

导出比对结果的详细信息

将拼接的clones导出为tab分隔文件

导出clones的详细信息

从clones&比对结果（*.clna）中导出特定clone的reads，如果没有指定clone，所有对应的reads都会被导出

exportAlignmentsForClones

从clones&比对结果（*.clna）中导出特定clone的比对结果

exportReads

mergeAlignments

filterAlignments

sortAlignments

alignmentsDiff

clonesDiff

slice

从vdjca文件导出原始reads

将若干*.vdjca文件合并为一个比对文件

过滤比对结果

根据read ID排序vdjca文件中的比对结果

计算两个vdjca文件的差异

计算两个clns文件的差异

分割clna文件

结果解读

输出文件包含内容

输出表头

cloneId

注释内容

clone识别号码

输出表头

cloneCount

cloneFraction

targetSequences

targetQualities

注释内容

clone数量

clone比例

目标序列

目标质量

allVHitsWithScore

所有V基因命中和评分

allDHitsWithScore

所有D基因命中和评分

allJHitsWithScore

allCHitsWithScore

allVAlignments

allDAlignments

allJAlignments

allCAlignments

nSeqFR1

minQualFR1

nSeqCDR1

minQualCDR1

nSeqFR2

minQualFR2

nSeqCDR2

minQualCDR2

nSeqFR3

minQualFR3

nSeqCDR3

minQualCDR3

nSeqFR4

minQualFR4

aaSeqFR1

aaSeqCDR1

aaSeqFR2

aaSeqCDR2

aaSeqFR3

aaSeqCDR3

所有J基因命中和评分

所有C基因命中和评分

所有V基因比对结果

所有D基因比对结果

所有J基因比对结果

所有C基因比对结果

FR1核苷酸序列

FR1最小质量

CDR1核苷酸序列

CDR1最小质量

FR2核苷酸序列

FR2最小质量

CDR2核苷酸序列

CDR2最小质量

FR3核苷酸序列

FR3最小质量

CDR3核苷酸序列

CDR3最小质量

FR4核苷酸序列

FR4最小质量

FR1氨基酸序列

CDR1氨基酸序列

FR2氨基酸序列

CDR2氨基酸序列

FR3氨基酸序列

CDR3氨基酸序列

输出表头

aaSeqFR4

refPoints

注释内容

FR4氨基酸序列

参考点