quast
Tags: assembly quality assessment metrics bactopia-tool
Avaliação de qualidade de contigs montados usando QUAST.
Esta Bactopia Tool utiliza o QUAST para avaliar a qualidade de contigs montados. O QUAST (Quality Assessment Tool for Genome Assemblies) gera relatórios abrangentes que incluem diversos gráficos e tabelas para ajudar a avaliar métricas de qualidade da montagem, como N50, conteúdo GC, fração do genoma e taxas de remontagem incorreta. Ele produz avaliações por amostra e resumos consolidados para análise comparativa entre múltiplas amostras.
Uso
Bactopia CLI:
bactopia --wf quast \
--bactopia /path/to/your/bactopia/results
Nextflow:
nextflow run bactopia/bactopia/workflows/bactopia-tools/quast/main.nf \
--bactopia /path/to/your/bactopia/results
Saídas
Arquivos de Saída Esperados
<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│ └── tools
│ └── quast-<TIMESTAMP>
│ ├── <SAMPLE_NAME>.tsv
│ ├── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ ├── quast.log
│ │ └── versions.yml
│ └── supplemental
│ ├── basic_stats
│ │ ├── <SAMPLE_NAME>_GC_content_plot.pdf
│ │ ├── GC_content_plot.pdf
│ │ ├── NGx_plot.pdf
│ │ ├── Nx_plot.pdf
│ │ └── cumulative_plot.pdf
│ ├── icarus.html
│ ├── icarus_viewers
│ │ └── contig_size_viewer.html
│ ├── predicted_genes
│ │ ├── <SAMPLE_NAME>_glimmer.stderr
│ │ └── <SAMPLE_NAME>_glimmer_genes.gff
│ ├── report.html
│ ├── report.pdf
│ ├── report.tex
│ ├── report.tsv
│ ├── report.txt
│ ├── transposed_report.tex
│ └── transposed_report.txt
└── bactopia-runs
└── quast-<TIMESTAMP>
├── merged-results
│ ├── logs
│ │ └── quast-concat
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ └── quast.tsv
└── nf-reports
├── quast-dag.dot
├── quast-report.html
└── quast-timeline.html
Resultados por Amostra
| Arquivo | Descrição |
|---|---|
*.tsv | Estatísticas resumidas da avaliação QUAST para cada amostra |
basic_stats/ | Diretório contendo gráficos de métricas da montagem (conteúdo GC, NGx, Nx) |
icarus.html | Menu principal do Icarus com links para visualizadores interativos |
icarus_viewers/ | Relatórios e visualizadores adicionais do Icarus |
predicted_genes/ | Diretório contendo informações sobre genes preditos |
report.* | Resumo da avaliação em diversos formatos (html, pdf, tex, tsv, txt) |
transposed_report.* | Versão transposta do resumo da avaliação (tex, tsv, txt) |
Resultados Consolidados
| Arquivo | Descrição |
|---|---|
quast.tsv | Arquivo TSV consolidado com estatísticas resumidas do QUAST de todas as amostras |
Trilha de Auditoria
Abaixo estão os arquivos que podem ajudar você a entender quais parâmetros e versões de programas foram utilizados.
Logs
Cada processo executado terá uma pasta chamada logs. Nessa pasta estão arquivos úteis
para revisão, caso seja necessário.
| Extensão | Descrição |
|---|---|
| .begin | 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 | 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 |
|---|---|
| quast-dag.dot | A visualização DAG do Nextflow |
| quast-report.html | O Relatório de Execução do Nextflow |
| quast-timeline.html | O Relatório de Linha do Tempo do Nextflow |
| quast-trace.txt | O relatório de Rastreamento do Nextflow |
Parâmetros
Parâmetros Obrigatórios
Defina 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 entrada |
Parâmetros do Quast
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--quast_contig_thresholds | string | 0,1000,10000,100000,250000,1000000 | Lista separada por vírgulas de limites de comprimento de contig |
--quast_plots_format | string | pdf | Salva gráficos no formato especificado (opções: emf, eps, pdf, png, ps, raw, rgba, svg, svgz) |
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 esses 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 serem incluídas na análise | |
--exclude | string | Um arquivo de texto contendo nomes de amostras (um por linha) a serem excluídas da análise |
Parâmetros Opcionais
Esses parâmetros opcionais podem ser úteis em determinadas situações.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
--outdir | string | bactopia | Diretório base para salvar os resultados |
--skip_compression | boolean | false | Os arquivos de saída não serão comprimidos |
--datasets | string | O caminho para armazenar datasets em cache | |
--keep_all_files | boolean | false | Mantém todos os arquivos de análise criados |
Parâmetros de Limite Máximo de Recursos
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 para 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 que sobrescreverá 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 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 | Link de 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 ambientes Conda | |
--registry | string | quay.io | Registro de onde os contêineres Docker serão baixados. |
--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 imagens Singularity diretamente, força o fluxo de trabalho a baixar e converter contêineres Docker. | |
--force_rebuild | boolean | false | Força a substituição 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 por um agendador de jobs (ex.: AWS Batch ou SLURM) |
--cluster_opts | string | Opções adicionais para passar ao executor. (ex.: SLURM: '--account=my_acct_name' | |
--container_opts | string | Opções adicionais para passar ao 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 raramente usados 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 | Booleano que indica se os parâmetros devem ser validados em relação ao esquema 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 | Mostra 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 utiliza os seguintes subworkflows:
- quast - Avalia a qualidade da montagem usando QUAST.
Citações
Se você usar isso em sua análise, por favor cite o seguinte.
-
Bactopia
Petit III RA, Read TD Bactopia - a flexible pipeline for complete analysis of bacterial genomes. mSystems 5 (2020) -
csvtk
Shen, W csvtk: A cross-platform, efficient and practical CSV/TSV toolkit in Golang. (GitHub) -
QUAST
Gurevich A, Saveliev V, Vyahhi N, Tesler G QUAST: quality assessment tool for genome assemblies. Bioinformatics 29, 1072-1075 (2013)