抗体库的质量控制管道
abseq的Python项目详细描述
目录
简介
abseq
abseq
是一个全面的生物信息管道,用于分析抗体库生成的测序数据集,abseqpy
是其软件包之一。给定fastq或fasta文件(成对或单端),abseqpy
生成clonotypes表,v-(d)-j germline注释,函数速率,以及
CSV和HDF文件组合中的多样性估计。抗体库的更专业化分析
像引物特异性、序列模体分析和限制性位点分析也在列表中。
此程序将与abseqr
一起使用,
由abseqpy
生成的数据的报告和统计分析包。尽管abseqpy
在没有abseqr
的情况下工作正常,但强烈建议用户也安装r包,以便利用管道的交互式html报告功能。abseqr
的项目页面显示了分析类型abseq
所提供的一些示例;完整的文档可以在abseqr
的vignette中找到。
开发人员
abseq
由Monther Alhamdoosh和Jiahong Fong开发- 有关意见和建议,请发送电子邮件至m.hamdoosh<;at>;gmail<;dot>;com
先决条件
abseqpy
依赖于一些外部软件来工作,它们应该是正确的
在运行abseqpy
之前安装并配置
< Buff行情>
abseqpy
在Python2.7上运行。python 3.6支持正在进行中。
无缝安装依赖项
这是安装abseqpy外部依赖项的建议方法。
python脚本可以在这里下载并安装所有必需的外部依赖项。
此脚本假定以下内容已可用:
- perl
- git
- 巨蟒 一个HReF= ="HTTP://www. Oracle .COM/TeaTeWorks/Java/JavaSe/DeLosis/JRe8下载-2133155.HTML"Re="NoFoLoLy"> JavaJRE 版本1.6或更高
- < HRIF= ="HTTPS://Gcc.GNUORG/Re="NoFoLoL> C/C++编译器< /A>(Windows不需要)
- 制作。(Windows不需要)
- cmake(Windows不需要)
将外部依赖项安装到名为~/.local/abseq
:
$ mkdir -p ~/.local/abseq $ python install_dependencies.py ~/.local/abseq< Buff行情>
此脚本不会安装abseqpy本身,只安装其外部依赖项。
此脚本适用于Python2和3,并且~/.local/abseq
可以替换为任何目录。
然而:
- 此目录将保留,请明智地选择
- 安装脚本将转储此目录中的二进制文件,它将包含数据库和内部文件
一旦安装成功,系统会在屏幕上提示用户
更新环境变量,使其包含~/.local/abseq
手动安装依赖项
本节适用于以下情况:
- 发现安装脚本失败
- 感到冒险
有关详细指南,请参阅本文档。
abseqpy安装
本节演示如何安装abseqpy
从pip安装
$ pip install abseqPy
从源安装
$ git clone https://github.com/malhamdoosh/abseqPy.git
$ cd abseqPy
$ pip install .
$ abseq --version
abseq
命令现在应该可以在命令行上使用。
安装abseqpy也安装其他python包,考虑使用python虚拟环境来防止
重写现有包。请参见virtualenv
或conda 要启动并运行,以下命令通常就足够了: 除了使用命令行选项调用 假设名为example.yml的文件具有以下内容: 然后执行 建议使用 在命令行中调用 由于软件不兼容,某些功能在Windows中运行时被禁用,它们是: <;small>;1<;/small>;<;small>;长选项名称是带有双短划线前缀的选项名称,例如,
用法
基本用法
$ abseq -f1 <read1> -f2 <read2> -o results --threads 4 --task all
-f2
仅在成对末端测序实验时才需要。高级用法
abseq
之外,abseq
还支持-y<;file>;
或-yaml<;file>;
读取文件中定义的参数。这样可以同时分析多个样本,每个样本
具有共享或独立的
abseq
参数。文件的基本yaml语法是
键:val
其中键是
abseq
"long"选项(所有"long"选项名称请参见abseq--help
)和
val
是提供给"long"选项的值。相继指定了其他样本
由三个破折号分隔--
示例
# sample one, PCR1name:PCR1file1:fastq/PCR1_R1.fastq.gzfile2:fastq/PCR1_R2.fastq.gz---# sample two, PCR2name:PCR2file1:fastq/PCR2_R1.fastq.gzfile2:fastq/PCR2_R2.fastq.gzbitscore:300# override the defaults' 350 for this sample onlytask:abundance# override the defaults' "all" for this sample onlydetailedComposition:~# enables detailedComposition (-dc) for this sample only---# more samples can go here---# "defaults" is the only special key allowed.# It is not in abseq's options, but is used here# to denote default values to be used for ALL samples# if they're not specified.defaults:task:alloutdir:resultsthreads:7bitscore:350sstart:1-3
abseq-y example.yml
相当于同时运行
abseq
将defaults
字段中的参数应用于两个示例。这里有一个
等效值:$ abseq --task all --outdir results --threads 7 --bitscore 350 --sstart 1-3 \
> --name PCR1 --file1 fastq/PCR1_R1.fastq.gz --file2 fastq/PCR1_R2.fastq.gz
$ abseq --task abundance --outdir results --threads 7 --bitscore 300 --sstart 1-3 \
> --name PCR2 --file1 fastq/PCR2_R1.fastq.gz --file2 fastq/PCR2_R2.fastq.gz \
> --detailedComposition
--yaml
,因为它是自文档的、可复制的和易于运行的。有问题
example的
将使用
7个线程,即,默认值
键中指定线程:7
。ymlabseqpy
将运行7个*示例数
总进程。帮助
abseq-h
将显示选项abseqpy
使用。支持的平台
abseqpy
适用于大多数Linux发行版、Mac OS和Windows。--task 5utr
--任务多样性中生成徽标
--help
是一个长选项,而-h
不是
推荐PyPI第三方库