Pular para o conteúdo principal

merlin

Tags: species-specific automated mash minmer typing bactopia-tool

Seleção e execução de ferramentas espécie-específicas assistida por MinMER.

Esta Bactopia Tool, Merlin, utiliza distâncias MinMER baseadas no sketch do RefSeq para executar automaticamente ferramentas de análise espécie-específicas. O Merlin identifica os genomas de referência mais próximos e executa as ferramentas de tipagem e análise adequadas para cada espécie detectada.

Uso

Bactopia CLI:

bactopia --wf merlin \
--bactopia /path/to/your/bactopia/results

Nextflow:

nextflow run bactopia/bactopia/workflows/bactopia-tools/merlin/main.nf \
--bactopia /path/to/your/bactopia/results

Saídas

Arquivos de Saída Esperados

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│ └── tools
│ ├── clermontyping
│ │ ├── <SAMPLE_NAME>.tsv
│ │ ├── logs
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ └── supplemental
│ │ ├── <SAMPLE_NAME>.blast.xml
│ │ ├── <SAMPLE_NAME>.html
│ │ └── <SAMPLE_NAME>.mash.tsv
│ ├── ectyper
│ │ ├── <SAMPLE_NAME>.blast_alleles.txt
│ │ ├── <SAMPLE_NAME>.tsv
│ │ └── logs
│ │ ├── ectyper.log
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── kleborate
│ │ ├── <SAMPLE_NAME>.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── merlindist
│ │ └── merlin-<TIMESTAMP>
│ │ ├── <SAMPLE_NAME>-dist.txt
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── shigapass
│ │ ├── <SAMPLE_NAME>.tsv
│ │ ├── logs
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ └── supplemental
│ │ └── ShigaPass_summary.csv
│ ├── shigatyper
│ │ ├── <SAMPLE_NAME>-hits.tsv
│ │ ├── <SAMPLE_NAME>.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── shigeifinder
│ │ ├── <SAMPLE_NAME>.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ └── stecfinder
│ ├── <SAMPLE_NAME>.tsv
│ └── logs
│ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ └── versions.yml
├── <SAMPLE_NAME>SE
│ └── tools
│ ├── clermontyping
│ │ ├── <SAMPLE_NAME>SE.tsv
│ │ ├── logs
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ └── supplemental
│ │ ├── <SAMPLE_NAME>SE.blast.xml
│ │ ├── <SAMPLE_NAME>SE.html
│ │ └── <SAMPLE_NAME>SE.mash.tsv
│ ├── ectyper
│ │ ├── <SAMPLE_NAME>SE.blast_alleles.txt
│ │ ├── <SAMPLE_NAME>SE.tsv
│ │ └── logs
│ │ ├── ectyper.log
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── kleborate
│ │ ├── <SAMPLE_NAME>SE.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── merlindist
│ │ └── merlin-<TIMESTAMP>
│ │ ├── <SAMPLE_NAME>SE-dist.txt
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── shigapass
│ │ ├── <SAMPLE_NAME>SE.tsv
│ │ ├── logs
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ └── supplemental
│ │ └── ShigaPass_summary.csv
│ ├── shigatyper
│ │ ├── <SAMPLE_NAME>SE-hits.tsv
│ │ ├── <SAMPLE_NAME>SE.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── shigeifinder
│ │ ├── <SAMPLE_NAME>SE.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ └── stecfinder
│ ├── <SAMPLE_NAME>SE.tsv
│ └── logs
│ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ └── versions.yml
├── SRR13039589
│ └── tools
│ ├── clermontyping
│ │ ├── SRR13039589.tsv
│ │ ├── logs
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ └── supplemental
│ │ ├── SRR13039589.blast.xml
│ │ ├── SRR13039589.html
│ │ └── SRR13039589.mash.tsv
│ ├── ectyper
│ │ ├── SRR13039589.blast_alleles.txt
│ │ ├── SRR13039589.tsv
│ │ └── logs
│ │ ├── ectyper.log
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── kleborate
│ │ ├── SRR13039589.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── merlindist
│ │ └── merlin-<TIMESTAMP>
│ │ ├── SRR13039589-dist.txt
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── shigapass
│ │ ├── SRR13039589.tsv
│ │ ├── logs
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ └── supplemental
│ │ └── ShigaPass_summary.csv
│ ├── shigatyper
│ │ ├── SRR13039589-hits.tsv
│ │ ├── SRR13039589.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── shigeifinder
│ │ ├── SRR13039589.tsv
│ │ └── logs
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ └── stecfinder
│ ├── SRR13039589.tsv
│ └── logs
│ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ └── versions.yml
└── bactopia-runs
└── merlin-<TIMESTAMP>
├── merged-results
│ ├── clermontyping.tsv
│ ├── ectyper.tsv
│ ├── kleborate.tsv
│ ├── logs
│ │ ├── clermontyping-concat
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ ├── ectyper-concat
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ ├── kleborate-concat
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ ├── shigapass-concat
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ ├── shigatyper-concat
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ ├── shigeifinder-concat
│ │ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ │ └── versions.yml
│ │ └── stecfinder-concat
│ │ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ │ └── versions.yml
│ ├── shigapass.tsv
│ ├── shigatyper.tsv
│ ├── shigeifinder.tsv
│ └── stecfinder.tsv
└── nf-reports
├── merlin-dag.dot
├── merlin-report.html
└── merlin-timeline.html

Análise Espécie-Específica

Nota

As ferramentas executadas dependem da espécie detectada

ArquivoDescrição
Analysisresultados de todas as ferramentas espécie-específicas executadas

Resultados Combinados

ArquivoDescrição
merlin.tsvResumo combinado de todas as análises espécie-específicas

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 estão arquivos úteis para você revisar caso necessário.

ExtensãoDescrição
.beginUm arquivo vazio usado para indicar que o processo foi iniciado
.errContém as saídas STDERR do processo
.logContém as saídas STDERR e STDOUT do processo
.outContém as saídas STDOUT do processo
.runO script que o Nextflow usa para preparar/remover arquivos e enfileirar processos com base no perfil fornecido
.shO script executado pelo bash para o processo
.traceO relatório de rastreamento do Nextflow para o processo
versions.ymlUm 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. Podem ser usados para otimizar o uso de recursos e estimar custos esperados ao utilizar plataformas em nuvem.

ArquivoDescrição
merlin-dag.dotA visualização DAG do Nextflow
merlin-report.htmlO Relatório de Execução do Nextflow
merlin-timeline.htmlO Relatório de Linha do Tempo do Nextflow
merlin-trace.txtO 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âmetroTipoPadrãoDescrição
--bactopiastringO caminho para os resultados do bactopia a serem usados como entradas

Parâmetros do mashdist

ParâmetroTipoPadrãoDescrição
--mash_sketchstringA sequência de referência como um Mash Sketch (arquivo .msh)
--mash_seedinteger42Semente fornecida à função hash
--mash_tablebooleanfalseSaída em formato de tabela (campos ficarão em branco se não atenderem ao limite de p-valor)
--mash_minteger1Número mínimo de cópias de cada k-mer necessário para passar pelo filtro de ruído para reads
--mash_wnumber0.01Limite de probabilidade para aviso sobre tamanho de k-mer pequeno
--mash_max_pnumber1.0Valor máximo de p a ser reportado
--mash_max_distnumber1.0Distância máxima a ser reportada
--merlin_distnumber0.1Distância máxima a ser reportada ao usar o Merlin
--full_merlinbooleanfalseAtiva o Merlin completo e executa todas as ferramentas espécie-específicas, independentemente da distância Mash
--mash_use_fastqsbooleanfalseConsultar com FASTQs em vez das montagens

Parâmetros do ClermonTyping

ParâmetroTipoPadrãoDescrição
--clermontyping_thresholdinteger0Não usar contigs abaixo deste tamanho

Parâmetros do csvtk concat

ParâmetroTipoPadrãoDescrição
--csvtk_concat_optsstringOpções extras do csvtk concat entre aspas

Parâmetros do ECTyper

ParâmetroTipoPadrãoDescrição
--ectyper_opidinteger90Percentual de identidade necessário para correspondência de alelo do antígeno O
--ectyper_opcovinteger90Percentual mínimo de cobertura necessário para correspondência de alelo do antígeno O
--ectyper_hpidinteger95Percentual de identidade necessário para correspondência de alelo do antígeno H
--ectyper_hpcovinteger50Percentual mínimo de cobertura necessário para correspondência de alelo do antígeno H
--ectyper_verifybooleanfalseHabilitar verificação de espécie de E. coli
--ectyper_print_allelesbooleanfalseImprime as sequências de alelos como coluna final, se habilitado

Parâmetros do emmtyper

ParâmetroTipoPadrãoDescrição
--emmtyper_wfstringblastFluxo de trabalho a ser usado pelo emmtyper. (opções: blast, pcr)
--emmtyper_blastdbstringCaminho para banco de dados EMM BLAST personalizado
--emmtyper_cluster_distanceinteger500Distância entre grupos de correspondências para considerar como clusters diferentes
--emmtyper_percidinteger95Percentual mínimo de identidade da sequência
--emmtyper_culling_limitinteger5Total de hits a retornar em uma posição
--emmtyper_mismatchinteger5Limite para o número de mismatches permitidos em um hit BLAST
--emmtyper_align_diffinteger5Limite para diferença entre comprimento do alinhamento e comprimento do sujeito no BLAST
--emmtyper_gapinteger2Limite de gap permitido em hit BLAST
--emmtyper_min_perfectinteger15Tamanho mínimo de correspondência perfeita na extremidade 3' do primer
--emmtyper_min_goodinteger15Tamanho mínimo onde deve haver 2 correspondências para cada mismatch
--emmtyper_max_sizeinteger2000Tamanho máximo do produto de PCR

Parâmetros do hicap

ParâmetroTipoPadrãoDescrição
--hicap_database_dirstringDiretório contendo o banco de dados de locus
--hicap_model_fpstringCaminho para o modelo prodigal
--hicap_full_sequencebooleanfalseEscrever a sequência de entrada completa no arquivo genbank em vez de apenas a região ao redor do locus
--hicap_debugbooleanfalsehicap imprimirá mensagens de depuração
--hicap_gene_coveragenumber0.8Percentual mínimo de cobertura para considerar um gene individual completo
--hicap_gene_identitynumber0.7Percentual mínimo de identidade para considerar um gene individual completo
--hicap_broken_gene_lengthinteger60Comprimento mínimo para considerar um gene quebrado
--hicap_broken_gene_identitynumber0.8Percentual mínimo de identidade para considerar um gene quebrado

Parâmetros do Mykrobe

ParâmetroTipoPadrãoDescrição
--mykrobe_speciesstringPainel de espécies a usar (opções: sonnei, staph, tb, typhi)
--mykrobe_kmerinteger21Comprimento do k-mer
--mykrobe_min_depthinteger1Profundidade mínima
--mykrobe_modelstringkmer_countModelo de genótipo utilizado. (opções: kmer_count, median_depth)
--mykrobe_report_all_callsbooleanfalseReportar todas as chamadas
--mykrobe_optsstringOpções extras do Mykrobe entre aspas

Parâmetros do GenoTyphi

ParâmetroTipoPadrãoDescrição
--genotyphi_kmerinteger21Comprimento do k-mer
--genotyphi_min_depthinteger1Profundidade mínima
--genotyphi_modelstringkmer_countModelo de genótipo utilizado. (opções: kmer_count, median_depth)
--genotyphi_report_all_callsbooleanfalseReportar todas as chamadas
--genotyphi_mykrobe_optsstringOpções extras do Mykrobe entre aspas

Parâmetros do Kleborate

ParâmetroTipoPadrãoDescrição
--kleborate_presetstringkpscMódulo preset a usar no Kleborate (opções: kpsc, kosc, escherichia)
--kleborate_optsstringOpções extras entre aspas para o Kleborate

Parâmetros do legsta

ParâmetroTipoPadrãoDescrição
--legsta_noheaderbooleanfalseNão imprimir linha de cabeçalho

Parâmetros do LisSero

ParâmetroTipoPadrãoDescrição
--lissero_min_idnumber95.0Percentual mínimo de identidade para aceitar uma correspondência
--lissero_min_covnumber95.0Cobertura mínima do gene para aceitar uma correspondência

Parâmetros do ngmaster

ParâmetroTipoPadrãoDescrição
--ngmaster_csvbooleanfalsesaída no formato separado por vírgulas (CSV) em vez de separado por tabulações

Parâmetros do pasty

ParâmetroTipoPadrãoDescrição
--pasty_min_pidentinteger95Percentual mínimo de identidade para contabilizar um hit
--pasty_min_coverageinteger95Percentual mínimo de cobertura para contabilizar um hit

Parâmetros do pbptyper

ParâmetroTipoPadrãoDescrição
--pbptyper_min_pidentinteger95Percentual mínimo de identidade para contabilizar um hit
--pbptyper_min_coverageinteger95Percentual mínimo de cobertura para contabilizar um hit

Parâmetros do SeqSero2

ParâmetroTipoPadrãoDescrição
--seqsero2_run_modestringkFluxo de trabalho a executar. 'a' modo alelo, ou 'k' modo k-mer (opções: a, k)
--seqsero2_input_typestringassemblyFormato de entrada a analisar. 'assembly' ou 'fastq' (opções: assembly, fastq)
--seqsero2_bwa_modestringmemAlgoritmos para mapeamento bwa no modo alelo (opções: mem, sam)

Parâmetros do SeroBA

ParâmetroTipoPadrãoDescrição
--seroba_nocleanbooleanfalseNão limpar arquivos intermediários
--seroba_coverageinteger20Limite de cobertura de k-mer da sequência de referência

Parâmetros do SISTR

ParâmetroTipoPadrãoDescrição
--sistr_full_cgmlstbooleanfalseUsar o conjunto completo de alelos cgMLST, que pode incluir alelos altamente similares

Parâmetros do AgrVATE

ParâmetroTipoPadrãoDescrição
--agrvate_typing_onlybooleanfalseApenas tipagem agr. Ignora a extração do operon agr e detecção de frameshift

Parâmetros do spaTyper

ParâmetroTipoPadrãoDescrição
--spatyper_repeatsstringLista de repetições spa
--spatyper_repeat_orderstringLista de tipos spa e ordem das repetições
--spatyper_do_enrichbooleanfalseRealizar enriquecimento de produto de PCR

Parâmetros do sccmec

ParâmetroTipoPadrãoDescrição
--sccmec_min_targets_pidentinteger90Percentual mínimo de identidade para contabilizar um hit de alvo
--sccmec_min_targets_coverageinteger80Percentual mínimo de cobertura para contabilizar um hit de alvo
--sccmec_min_regions_pidentinteger85Percentual mínimo de identidade para contabilizar um hit de região
--sccmec_min_regions_coverageinteger93Percentual mínimo de cobertura para contabilizar um hit de região

Parâmetros do StaphSCAN

ParâmetroTipoPadrãoDescrição
--staphscan_modulesstringLista de módulos a executar separados por vírgula
--staphscan_db_mlststringCaminho ou tarball para banco de dados MLST personalizado

Parâmetros do STECFinder

ParâmetroTipoPadrãoDescrição
--stecfinder_use_readsbooleanfalseReads paired-end Illumina serão usados em vez de montagens
--stecfinder_hitsbooleanfalseMostrar resultados detalhados de busca de genes
--stecfinder_cutoffnumber10.0Cobertura mínima de reads para chamar um gene
--stecfinder_lengthnumber50.0Percentual do comprimento do gene necessário para chamada positiva
--stecfinder_ipah_lengthnumber10.0Percentual do comprimento do gene ipaH necessário para chamada de gene positiva
--stecfinder_ipah_depthnumber1.0Profundidade mínima para chamada positiva do gene ipaH (requer --stecfinder_use_reads)
--stecfinder_stx_lengthnumber10.0Percentual do comprimento do gene stx necessário para chamada de gene positiva
--stecfinder_stx_depthnumber1.0Profundidade mínima para chamada positiva do gene stx (requer --stecfinder_use_reads)
--stecfinder_o_lengthnumber60.0Percentual do comprimento do gene wz_ necessário para chamada positiva
--stecfinder_o_depthnumber1.0Profundidade mínima para chamada positiva do gene qz_ (requer --stecfinder_use_reads)
--stecfinder_h_lengthnumber60.0Percentual do comprimento do gene fliC necessário para chamada positiva
--stecfinder_h_depthnumber1.0Profundidade mínima para chamada positiva do gene fliC (requer --stecfinder_use_reads)

Parâmetros do TB-Profiler Profile

ParâmetroTipoPadrãoDescrição
--tbprofiler_call_whole_genomebooleanfalseChamar genoma completo
--tbprofiler_mapperstringbwaFerramenta de mapeamento a usar. Se estiver usando dados nanopore, o padrão será minimap2 (opções: bwa, minimap2, bowtie2, bwa-mem2)
--tbprofiler_callerstringfreebayesFerramenta de chamada de variantes a usar (opções: bcftools, gatk, freebayes)
--tbprofiler_calling_paramsstringOpções extras do chamador de variantes entre aspas
--tbprofiler_suspectbooleanfalseUsar o conjunto de ferramentas suspect para adicionar predições de ML
--tbprofiler_no_flagstatbooleanfalseNão coletar flagstats
--tbprofiler_no_dellybooleanfalseNão executar delly
--tbprofiler_optsstringOpções extras entre aspas para o TBProfiler

Parâmetros do TB-Profiler Collate

ParâmetroTipoPadrãoDescrição
--tbprofiler_itolbooleanfalseGerar arquivos de configuração itol
--tbprofiler_fullbooleanfalseIncluir mutações no arquivo de resultado principal
--tbprofiler_all_variantsbooleanfalseIncluir todas as variantes na matriz de variantes
--tbprofiler_mark_missingbooleanfalseUm asterisco será usado para marcar predições afetadas por dados ausentes em posição de resistência a drogas
Parâmetros de Filtragem

Use esses parâmetros para especificar quais amostras incluir ou excluir.

ParâmetroTipoPadrãoDescrição
--includestringUm arquivo de texto contendo nomes de amostras (um por linha) a incluir na análise
--excludestringUm arquivo de texto contendo nomes de amostras (um por linha) a excluir da análise
Parâmetros Opcionais

Esses parâmetros opcionais podem ser úteis em determinadas situações.

ParâmetroTipoPadrãoDescrição
--outdirstringbactopiaDiretório base para salvar os resultados
--skip_compressionbooleanfalseOs arquivos de saída não serão comprimidos
--datasetsstringO caminho para armazenar em cache os conjuntos de dados
--keep_all_filesbooleanfalseMantém todos os arquivos de análise criados
Parâmetros de Recursos Máximos por Job

Define o limite máximo de recursos solicitados para qualquer job individual.

ParâmetroTipoPadrãoDescrição
--max_retryinteger3Número máximo de tentativas de um processo antes de permitir que falhe
--max_cpusinteger4Número máximo de CPUs que podem ser solicitadas para qualquer job individual
--max_memorystring128.GBQuantidade máxima de memória que pode ser solicitada para qualquer job individual
--max_timestring240.hTempo máximo que pode ser solicitado para qualquer job individual
--max_downloadsinteger3Número máximo de amostras para baixar simultaneamente
Parâmetros de Configuração do Nextflow

Parâmetros para ajustar sua configuração do Nextflow.

ParâmetroTipoPadrãoDescrição
--nfconfigstringUm arquivo de configuração compatível com Nextflow para perfis personalizados, carregado por último e que substituirá variáveis existentes se definido
--publish_dir_modestringcopyMétodo usado para salvar os resultados do pipeline no diretório de saída. (opções: symlink, rellink, link, copy, copyNoFollow, move)
--infodirstring${params.outdir}/pipeline_infoDiretório para manter os logs e relatórios do Nextflow do pipeline
--forcebooleanfalseO Nextflow irá sobrescrever arquivos de saída existentes
--cleanup_workdirbooleanfalseApó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âmetroTipoPadrãoDescrição
--custom_config_versionstringmasterID de commit Git para configurações institucionais
--custom_config_basestringhttps://raw.githubusercontent.com/nf-core/configs/masterDiretório base para configurações institucionais
--config_profile_namestringNome do perfil de configuração institucional
--config_profile_descriptionstringDescrição do perfil de configuração institucional
--config_profile_contactstringInformações de contato do perfil de configuração institucional
--config_profile_urlstringURL do perfil de configuração institucional
Parâmetros de Perfil do Nextflow

Parâmetros para ajustar sua configuração do Nextflow.

ParâmetroTipoPadrãoDescrição
--condadirstringDiretório que o Nextflow deve usar para ambientes Conda
--registrystringquay.ioRegistro de onde baixar os contêineres Docker
--datasets_cachestring<HOME>/.bactopia/datasetsDiretório onde os conjuntos de dados baixados devem ser armazenados
--singularity_cachestringDiretório onde as imagens Singularity remotas são armazenadas
--singularity_pull_docker_containerbooleanEm vez de baixar imagens Singularity diretamente, forçar o fluxo de trabalho a baixar e converter contêineres Docker
--force_rebuildbooleanfalseForçar a sobrescrita de ambientes pré-construídos existentes
--queuestringgeneral,high-memoryNome(s) da(s) fila(s) separados por vírgula a serem usados por um agendador de jobs (ex: AWS Batch ou SLURM)
--cluster_optsstringOpções adicionais a passar ao executor. (ex: SLURM: '--account=my_acct_name')
--container_optsstringOpções adicionais a passar ao Apptainer, Docker ou Singularity. (ex: Singularity: '-D pwd')
--disable_scratchbooleanfalseTodos os arquivos intermediários criados nos nós de trabalho serão transferidos para o nó principal
Parâmetros Úteis

Parâmetros usados com pouca frequência que podem ser úteis.

ParâmetroTipoPadrãoDescrição
--monochrome_logsbooleanNão usar saídas de log coloridas
--nfdirbooleanImprimir o diretório para o qual o Nextflow baixou o Bactopia
--sleep_timeinteger5O tempo (em segundos) que o Nextflow aguardará após configurar os conjuntos de dados antes da execução
--validate_paramsbooleantrueBooleano para validar os parâmetros em relação ao esquema em tempo de execução
--helpbooleanExibir texto de ajuda
--wfstringbactopiaEspecificar qual fluxo de trabalho ou Bactopia Tool executar
--list_wfsbooleanListar os fluxos de trabalho e Bactopia Tools disponíveis para usar com '--wf'
--show_hidden_paramsbooleanMostrar todos os parâmetros ao usar --help
--help_allbooleanUm alias para --help --show_hidden_params
--versionbooleanExibir texto da versão

Composição

Este fluxo de trabalho utiliza os seguintes subworkflows:

  • bactopia_datasets - Baixar e fornecer conjuntos de dados pré-compilados necessários pelo Bactopia.
  • merlin - Seleção de ferramentas bactopia espécie-específicas assistida por MinER.

Citações

Se você usar isso em sua análise, cite o seguinte.

Fonte

Ver fonte no GitHub