通过组装鉴定抗菌素耐药性
有关如何使用Ariba,请参阅Ariba Wiki页面。
请注意:我们目前没有资源来为Ariba提供支持 - 请参阅“反馈/问题”部分。
介绍
快速开始
安装
所需的依赖项
使用pip3
来自来源
Docker
奇异性
Debian(测试)
Ubuntu
依赖性和环境变量
临时文件
用法
执照
反馈/问题
引用
Ariba是一种通过运行局部组件来识别抗生素抗性基因的工具。它也可以用于MLST调用。
输入是参考序列的FASTA文件(可以是基因和非编码序列的混合)和配对的测序读数。 Ariba报告发现了哪些参考序列,以及有关组件质量以及测序读取和参考序列之间的任何变体的详细信息。
例如,从卡中获取参考数据。有关完整列表,请参见GetRef。
ariba getref ncbi out.ncbi
准备Ariba的参考数据:
ariba prepareref -f out.ncbi.fa -m out.ncbi.tsv out.ncbi.prepareref
运行本地组件并调用变体:
ariba run out.ncbi.prepareref reads1.fastq reads2.fastq out.run
总结几个运行的数据:
ariba summary out.summary out.run1/report1.tsv out.run2/report2.tsv out.run3/report3.tsv
请阅读Ariba Wiki页面以获取完整的使用说明。
Jupyter笔记本教程
如果您在安装ARIBA时遇到问题,请联系您的本地系统管理员。如果遇到错误,则可以在此处记录它。
python3版本> = 3.6.0
Bowtie2版本> = 2.1.0
CD-HIT版本> = 4.6
妈妈版本> = 3.23
Ariba还取决于几个Python软件包,所有这些软件包都可以通过PIP获得。如果尚未安装Ariba,则使用PIP3安装它们将自动获取这些内容:
树枝状> = 4.2.0
matplotlib> = 3.1.0
pyfastaq> = 3.12.0
PYSAM> = 0.9.1
pymummer> = 0.10.1
Biopython
使用PIP安装Ariba:
pip3 install ariba
从此GitHub存储库下载最新版本或克隆它。运行测试:
python3 setup.py test
注意操作系统X:测试需要gawk,需要单独安装,例如通过自制。
如果测试全部通过,请安装:
python3 setup.py install
另外,可以直接从GitHub安装:
pip3 install git+https://github.com/sanger-pathogens/ariba.git #--user
Ariba可以在Docker容器中运行。首先安装Docker,然后安装最新版本的Ariba:
docker pull gchr.io/sanger-pathogens/ariba:latest
所有Docker图像均在“软件包”页面中列出。
使用Ariba使用这样的命令(在您的目录中替换),假定文件存储在/home/ubuntu/data中:
docker run --rm -it -v /home/ubuntu/data:/data sangerpathogens/ariba ariba -h
当通过Docker调用Ariba(如上)时,您还需要在文件或目录名称中所有传递的所有传递的数据(例如 /data /my_output_folder)中添加/数据 / 。
Ariba可以在奇异容器中运行。首先安装奇异性。版本包括要下载的奇异图像。
或者,构建自己的奇异图像:
singularity build ariba.simg Singularity.def
Ariba可在最新版本的Debian中使用,随着时间的流逝,将逐渐过滤到Ubuntu和使用Debian的其他发行版。将其安装为root:
sudo apt-get install ariba
您可以使用apt-get
(请参见上文),也可以确保您获得最新版本的Ariba,以下命令可用于安装Ariba及其依赖关系。这是在Ubuntu 16.04的新实例上进行了测试。
sudo apt-get update sudo apt-get install -y python3-dev python3-pip python3-tk zlib1g-dev bowtie2 mummer cd-hit export ARIBA_CDHIT=cdhit-est sudo pip3 install ariba
默认情况下,Ariba将使用下表中的名称在您的$PATH
中寻找依赖项。可以覆盖此行为,并使用环境变量将Ariba指向特定程序。首先检查环境变量,并在设置设置时使用。否则,Ariba在您的$PATH
中查看默认名称。这适用于以下依赖关系。
依赖性 | 默认可执行文件 | 环境变量名称 |
---|---|---|
Bowtie2 | bowtie2 | $ARIBA_BOWTIE2 |
CD-HIT(EST) | cd-hit-est | $ARIBA_CDHIT |
例如,您可以指定您在主目录中编译和下载的Bowtie2可执行文件的确切版本(假设Bash):
export ARIBA_BOWTIE2=$HOME/bowtie2-2.1.0/bowtie2
请注意,Ariba还运行bowtie2-build
,为此,它将其使用的bowtie2
可执行,并附加了-build
。因此,在这种情况下,它将尝试使用
$HOME/bowtie2-2.1.0/bowtie2-build
Ariba可以在运行时暂时制作大量文件,这些文件位于Ariba制作的临时目录中。 这些文件的总大小很小,但是可能有很多。当在同一文件系统上同时运行大量数字(100或1000)作业时,这可能是一个问题。临时目录的父目录按以下优先顺序确定:
选项的值--tmp_dir
(如果使用该选项)
环境变量$ARIBA_TMPDIR
(如果设置)
环境变量$TMPDIR
(如果设置)
如果找不到上述内容,请使用Run的输出目录。
每个临时目录都是Ariba运行的独特之处,并且在运行结束时会自动删除(即使Ariba被用户杀死或坠毁)。例如,
export $ARIBA_TMPDIR=/tmp
将导致在内部/tmp
内部创建一个新目录,该目录的名称为表单
/tmp/ariba.tmp.abcdef
如果后缀abcdef
是一个随机的字符串,则选择/tmp/ariba.tmp.abcdef
尚不存在。
上述例外是使用该选项--noclean
。这迫使要放置在输出目录中的临时目录,并保留临时文件。它旨在调试。
usage: ariba <command> <options> optional arguments: -h, --help show this help message and exit Available commands: aln2meta Converts multi-aln fasta and SNPs to metadata expandflag Expands flag column of report file flag Translate the meaning of a flag getref Download reference data micplot Make violin/dot plots using MIC data prepareref Prepare reference data for input to "run" pubmlstget Download species from PubMLST and make db pubmlstspecies Get list of available species from PubMLST refquery Get cluster or sequence info from prepareref output run Run the local assembly pipeline summary Summarise multiple reports made by "run" test Run small built-in test dataset version Get versions and exit
请阅读Ariba Wiki页面以获取完整的使用说明。
Ariba是免费软件,根据GPLV3许可。
我们目前没有资源来为阿里巴提供支持。但是,如果您将有关软件使用的任何问题报告到“问题”页面上,社区也许可以为您提供帮助。
如果您使用此软件,请引用:
Ariba:直接从测序的快速抗菌耐药性基因分型读取Hunt M,Mather AE,Sánchez-BusóL,Page AJ,Parkhill J,Keane JA,Harris SR。微生物基因组学2017。doi:110.1099/mgen.0.000131