blastn
Tags: fasta blast alignment nucleotide similarity bactopia-tool
Pesquise em bancos de dados nucleotídicos do BLAST usando consultas nucleotídicas.
Esta Bactopia Tool usa BLASTN para consultar sequências nucleotídicas em bancos de dados nucleotídicos para busca de similaridade de sequências. O BLASTN encontra regiões de similaridade local entre sequências nucleotídicas.
Uso
Bactopia CLI:
bactopia --wf blastn \
--bactopia /path/to/your/bactopia/results
Nextflow:
nextflow run bactopia/bactopia/workflows/bactopia-tools/blastn/main.nf \
--bactopia /path/to/your/bactopia/results
Saídas
Arquivos de Saída Esperados
<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│ └── tools
│ └── blastn-<TIMESTAMP>
│ ├── <SAMPLE_NAME>.blastn.tsv
│ └── logs
│ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ └── versions.yml
└── bactopia-runs
└── blastn-<TIMESTAMP>
├── merged-results
│ ├── blastn.tsv
│ └── logs
│ └── blastn-concat
│ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ └── versions.yml
└── nf-reports
├── blastn-dag.dot
├── blastn-report.html
└── blastn-timeline.html
Resultados por Amostra
| Arquivo | Descrição |
|---|---|
*.blastn.tsv | Resultados de alinhamento do BLASTN em formato tabular |
*.blastn.html | Relatório HTML interativo dos resultados do BLASTN |
Resultados Consolidados
| Arquivo | Descrição |
|---|---|
blastn.tsv | Resultados do BLASTN consolidados de todas as amostras |
Trilha de Auditoria
Abaixo estão os arquivos que podem ajudá-lo a entender quais parâmetros e versões de programas foram utilizados.
Logs
Cada processo executado terá uma pasta chamada logs. Nessa pasta há arquivos úteis
para revisão caso necessário.
| Extensão | Descrição |
|---|---|
| .begin | Um arquivo vazio usado para indicar que o processo foi iniciado |
| .err | Contém as saídas STDERR do processo |
| .log | Contém as saídas STDERR e STDOUT do processo |
| .out | Contém as saídas STDOUT do processo |
| .run | O script que o Nextflow usa para preparar/remover arquivos e enfileirar processos com base no perfil definido |
| .sh | O script executado pelo bash para o processo |
| .trace | O relatório de rastreamento do Nextflow para o processo |
| versions.yml | Um arquivo no formato YAML com as versões dos programas |
Relatórios do Nextflow
Esses relatórios do Nextflow fornecem um excelente resumo da sua execução. Eles podem ser usados para otimizar o uso de recursos e estimar custos esperados ao utilizar plataformas em nuvem.
| Arquivo | Descrição |
|---|---|
| blastn-dag.dot | A visualização DAG do Nextflow |
| blastn-report.html | O Relatório de Execução do Nextflow |
| blastn-timeline.html | O Relatório de Linha do Tempo do Nextflow |
| blastn-trace.txt | O relatório de Rastreamento do Nextflow |
Parâmetros
Parâmetros Obrigatórios
Define onde o pipeline deve encontrar os dados de entrada e salvar os dados de saída.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--bactopia | string | O caminho para os resultados do bactopia a serem usados como entradas |
Parâmetros do BLASTN
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--blastn_query | string | Um arquivo fasta contendo as sequências de consulta para o BLAST contra o banco de dados | |
--blastn_outfmt | string | sseqid qseqid pident qlen slen length nident positive mismatch gapopen gaps qstart qend sstart send evalue bitscore | As colunas a incluir com -outfmt 6 |
--blastn_opts | string | Opções adicionais a passar para o BLASTN | |
--blastn_perc_identity | integer | 50 | Percentual de identidade |
--blastn_qcov_hsp_perc | integer | 50 | Percentual de cobertura da consulta por hsp |
--blastn_max_target_seqs | integer | 2000 | Número máximo de sequências alinhadas a manter |
--blastn_use_genes | boolean | false | Executar BLAST contra sequências de genes em vez de contigs |
Parâmetros do csvtk concat
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--csvtk_concat_opts | string | Opções extras do csvtk concat entre aspas |
Parâmetros de Filtragem
Use estes parâmetros para especificar quais amostras incluir ou excluir.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--include | string | Um arquivo de texto contendo nomes de amostras (um por linha) a incluir na análise | |
--exclude | string | Um arquivo de texto contendo nomes de amostras (um por linha) a excluir da análise |
Parâmetros Opcionais
Estes parâmetros opcionais podem ser úteis em determinadas situações.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--outdir | string | bactopia | Diretório base para gravar os resultados |
--skip_compression | boolean | false | Os arquivos de saída não serão comprimidos |
--datasets | string | O caminho para armazenar em cache os datasets | |
--keep_all_files | boolean | false | Mantém todos os arquivos de análise criados |
Parâmetros de Requisição Máxima de Jobs
Define o limite máximo de recursos solicitados para qualquer job individual.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--max_retry | integer | 3 | Número máximo de tentativas de um processo antes de permitir que ele falhe. |
--max_cpus | integer | 4 | Número máximo de CPUs que podem ser solicitadas para qualquer job individual. |
--max_memory | string | 128.GB | Quantidade máxima de memória que pode ser solicitada para qualquer job individual. |
--max_time | string | 240.h | Tempo máximo que pode ser solicitado para qualquer job individual. |
--max_downloads | integer | 3 | Número máximo de amostras a baixar simultaneamente |
Parâmetros de Configuração do Nextflow
Parâmetros para ajustar a configuração do Nextflow.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--nfconfig | string | Um arquivo de configuração compatível com Nextflow para perfis personalizados, carregado por último e substituirá variáveis existentes se definido. | |
--publish_dir_mode | string | copy | Método usado para salvar os resultados do pipeline no diretório de saída. (opções: symlink, rellink, link, copy, copyNoFollow, move) |
--infodir | string | ${params.outdir}/pipeline_info | Diretório para manter os logs e relatórios do Nextflow do pipeline. |
--force | boolean | false | O Nextflow irá sobrescrever arquivos de saída existentes. |
--cleanup_workdir | boolean | false | Após a execução bem-sucedida do Bactopia, o diretório work será excluído. |
Opções de configuração institucional
Parâmetros usados para descrever perfis de configuração centralizados. Estes não devem ser editados.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--custom_config_version | string | master | ID do commit Git para configurações institucionais. |
--custom_config_base | string | https://raw.githubusercontent.com/nf-core/configs/master | Diretório base para configurações institucionais. |
--config_profile_name | string | Nome do perfil de configuração institucional. | |
--config_profile_description | string | Descrição do perfil de configuração institucional. | |
--config_profile_contact | string | Informações de contato do perfil de configuração institucional. | |
--config_profile_url | string | URL do perfil de configuração institucional. |
Parâmetros de Perfil do Nextflow
Parâmetros para ajustar a configuração do Nextflow.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--condadir | string | Diretório que o Nextflow deve usar para os ambientes Conda | |
--registry | string | quay.io | Registro para baixar os containers Docker. |
--datasets_cache | string | <HOME>/.bactopia/datasets | Diretório onde os datasets baixados devem ser armazenados. |
--singularity_cache | string | Diretório onde as imagens Singularity remotas são armazenadas. | |
--singularity_pull_docker_container | boolean | Em vez de baixar diretamente imagens Singularity, força o fluxo de trabalho a baixar e converter containers Docker. | |
--force_rebuild | boolean | false | Força a sobrescrita de ambientes pré-construídos existentes. |
--queue | string | general,high-memory | Nome(s) separado(s) por vírgula da(s) fila(s) a serem usadas pelo agendador de jobs (ex.: AWS Batch ou SLURM) |
--cluster_opts | string | Opções adicionais a passar para o executor. (ex.: SLURM: '--account=my_acct_name' | |
--container_opts | string | Opções adicionais a passar para Apptainer, Docker ou Singularity. (ex.: Singularity: '-D pwd' | |
--disable_scratch | boolean | false | Todos os arquivos intermediários criados nos nós de trabalho serão transferidos para o nó principal. |
Parâmetros Úteis
Parâmetros pouco comuns que podem ser úteis.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--monochrome_logs | boolean | Não usar saídas de log coloridas. | |
--nfdir | boolean | Exibe o diretório para o qual o Nextflow baixou o Bactopia | |
--sleep_time | integer | 5 | O tempo (em segundos) que o Nextflow aguardará após configurar os datasets antes da execução. |
--validate_params | boolean | true | Define se os parâmetros devem ser validados em relação ao schema em tempo de execução |
--help | boolean | Exibe o texto de ajuda. | |
--wf | string | bactopia | Especifica qual fluxo de trabalho ou Bactopia Tool executar |
--list_wfs | boolean | Lista os fluxos de trabalho e Bactopia Tools disponíveis para uso com '--wf' | |
--show_hidden_params | boolean | Exibe todos os parâmetros ao usar --help | |
--help_all | boolean | Um alias para --help --show_hidden_params | |
--version | boolean | Exibe o texto da versão. |
Composição
Este fluxo de trabalho usa os seguintes subworkflows:
- blastn - Pesquisa em um banco de dados nucleotídico usando sequências de consulta nucleotídicas.
Citações
Se você usar esta ferramenta em sua análise, por favor cite os seguintes trabalhos.
-
Bactopia
Petit III RA, Read TD Bactopia - a flexible pipeline for complete analysis of bacterial genomes. mSystems 5 (2020) -
BLAST
Camacho C, Coulouris G, Avagyan V, Ma N, Papadopoulos J, Bealer K, Madden TL BLAST+: architecture and applications. BMC Bioinformatics 10, 421 (2009)