ariba
2.14.7
Identificação de resistência antimicrobiana por montagem
Para usar o Ariba, consulte a página do Wiki do Ariba.
Observação: atualmente não temos os recursos para fornecer suporte à Ariba - consulte a seção Feedback/problemas.
Introdução
Início rápido
Instalação
Dependências necessárias
Usando PIP3
Da fonte
Docker
Singularidade
Debian (teste)
Ubuntu
Dependências e variáveis de ambiente
Arquivos temporários
Uso
Licença
Feedback/problemas
Citação
O Ariba é uma ferramenta que identifica genes de resistência a antibióticos executando conjuntos locais. Também pode ser usado para chamadas MLST.
A entrada é um arquivo fasta das seqüências de referência (pode ser uma mistura de genes e seqüências de não codificação) e leituras de seqüenciamento emparelhadas. A Ariba relata quais das seqüências de referência foram encontradas, além de informações detalhadas sobre a qualidade dos assemblies e quaisquer variantes entre as leituras de sequenciamento e as seqüências de referência.
Obtenha dados de referência, por exemplo, do cartão. Veja GetRef para uma lista completa.
ariba getref ncbi out.ncbi
Prepare dados de referência para Ariba:
ariba prepareref -f out.ncbi.fa -m out.ncbi.tsv out.ncbi.prepareref
Execute as assembléias locais e ligue para as variantes:
ariba run out.ncbi.prepareref reads1.fastq reads2.fastq out.run
Resuma dados de várias execuções:
ariba summary out.summary out.run1/report1.tsv out.run2/report2.tsv out.run3/report3.tsv
Leia a página do Ariba Wiki para obter instruções completas de uso.
O tutorial de notebook Jupyter
Se você encontrar um problema ao instalar o Ariba, entre em contato com o administrador do sistema local. Se você encontrar um bug, poderá registrá -lo aqui.
Versão Python3> = 3.6.0
BOWTIE2 Versão> = 2.1.0
Versão CD-Hit> = 4.6
Versão mummer> = 3.23
A Ariba também depende de vários pacotes Python, todos disponíveis via PIP. A instalação do ARIBA com PIP3 os receberá automaticamente se ainda não estiverem instalados:
dendropy> = 4.2.0
matplotlib> = 3.1.0
pyfasthaq> = 3.12.0
Pysam> = 0.9.1
pymummer> = 0,10.1
Biopython
Instale o Ariba usando PIP:
pip3 install ariba
Faça o download do lançamento mais recente deste repositório do GitHub ou clone -o. Execute os testes:
python3 setup.py test
NOTA PARA OS X: Os testes requerem Gawk, que precisarão ser instalados separadamente, por exemplo, via homebrew.
Se todos os testes passarem, instale:
python3 setup.py install
Como alternativa, instale diretamente no github usando:
pip3 install git+https://github.com/sanger-pathogens/ariba.git #--user
O Ariba pode ser executado em um recipiente do docker. Primeiro Instale o Docker e depois instale a versão mais recente do Ariba:
docker pull gchr.io/sanger-pathogens/ariba:latest
Todas as imagens do Docker estão listadas na página de pacotes.
Para usar o Ariba, use um comando como este (substituindo seus diretórios), onde seus arquivos são assumidos como armazenados em/home/ubuntu/dados:
docker run --rm -it -v /home/ubuntu/data:/data sangerpathogens/ariba ariba -h
Ao ligar para o Ariba via Docker (como acima), você também precisará adicionar /dados / em frente a todos os nomes de arquivo ou diretório (por exemplo, Data /my_output_folder).
O Ariba pode ser executado em um recipiente de singularidade. Primeiro instale a singularidade. Os lançamentos incluem uma imagem de singularidade para download.
Como alternativa, construa sua própria imagem de singularidade:
singularity build ariba.simg Singularity.def
A Ariba está disponível na versão mais recente do Debian e, com o tempo, será progressivamente filtrado até o Ubuntu e outras distribuições que usam o Debian. Para instalá -lo como root:
sudo apt-get install ariba
Você pode usar apt-get (veja acima) ou para garantir que você obtenha a versão mais recente do Ariba, os seguintes comandos podem ser usados para instalar o Ariba e suas dependências. Isso foi testado em uma nova instância do 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
Por padrão, a Ariba procurará as dependências no seu $PATH , usando os nomes na tabela abaixo. Esse comportamento pode ser substituído e apontar o Ariba para um programa específico usando variáveis de ambiente. A variável de ambiente é verificada primeiro e é usada se estiver definida. Caso contrário, a Ariba procura seu $PATH para o nome padrão. Isso se aplica às seguintes dependências.
| Dependência | Executável padrão | Nome da variável do ambiente |
|---|---|---|
| Bowtie2 | bowtie2 | $ARIBA_BOWTIE2 |
| CD-Hit (EST) | cd-hit-est | $ARIBA_CDHIT |
Por exemplo, você pode especificar uma versão exata de um executável Bowtie2 que você compilou e baixou em seu diretório doméstico (assumindo o BASH):
export ARIBA_BOWTIE2=$HOME/bowtie2-2.1.0/bowtie2
Observe que o Ariba também executa bowtie2-build , para o qual usa o executável bowtie2 com -build anexado. Então, neste caso, tentaria usar
$HOME/bowtie2-2.1.0/bowtie2-build
O Ariba pode criar temporariamente um grande número de arquivos durante a execução, que são colocados em um diretório temporário feito pela Ariba. O tamanho total desses arquivos é pequeno, mas pode haver muitos deles. Isso pode ser um problema ao executar grandes números (100 ou 1000s) de trabalhos simultaneamente no mesmo sistema de arquivos. O diretório pai do diretório temporário é determinado na seguinte ordem de precedência:
O valor da opção --tmp_dir (se essa opção foi usada)
A variável de ambiente $ARIBA_TMPDIR (se estiver definido)
A variável de ambiente $TMPDIR (se estiver definido)
Se nenhuma das opções acima for encontrada, use o diretório de saída da execução.
Cada diretório temporário é exclusivo de uma corrida de Ariba e é excluído automaticamente no final da execução (mesmo que o Ariba tenha sido morto pelo usuário ou travado). Por exemplo,
export $ARIBA_TMPDIR=/tmp
resultará na criação de um novo diretório dentro /tmp , que terá um nome do formulário
/tmp/ariba.tmp.abcdef
Onde o sufixo abcdef é uma sequência aleatória de caracteres, escolhido de modo que /tmp/ariba.tmp.abcdef ainda não existe.
A exceção ao exposto é se a opção --noclean for usada. Isso força o diretório temporário a ser colocado no diretório de saída e os arquivos temporários são mantidos. Destina -se à depuração.
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
Leia a página do Ariba Wiki para obter instruções completas de uso.
A Ariba é um software livre, licenciado no GPLV3.
Atualmente, não temos os recursos para fornecer suporte à Ariba. No entanto, a comunidade poderá ajudá -lo se você relatar algum problema sobre o uso do software na página de problemas.
Se você usar este software, cite:
ARIBA: Genotipagem rápida de resistência antimicrobiana diretamente do sequenciamento Reads Hunt M, Mather AE, Sánchez-Busó L, Page AJ, Parkhill J, Keane JA, Harris SR. Genômica microbiana 2017. doi: 110.1099/mgen.0.000131
