Suporte de versão para linguagens HealthOmics de definição de fluxo de trabalho

HealthOmics suporta arquivos de definição de fluxo de trabalho escritos em Nextflow, WDL ou CWL. As seções a seguir fornecem informações sobre o suporte de HealthOmics versão para esses idiomas.

Suporte à versão WDL

HealthOmics suporta as versões 1.0, 1.1 e a versão de desenvolvimento da especificação WDL.

Todo documento da Biblioteca Digital Mundial deve incluir uma declaração de versão para especificar a qual versão (principal e secundária) da especificação ele adere. Para obter mais informações sobre versões, consulte Controle de versão da WDL

As versões 1.0 e 1.1 da especificação WDL não suportam o Directory tipo. Para usar o Directory tipo para entradas ou saídas, defina a versão como development na primeira linha do arquivo:

version development  # first line of .wdl file
     ... remainder of the file ... 

Suporte à versão CWL

HealthOmics suporta as versões 1.0, 1.1 e 1.2 da linguagem CWL.

Você pode especificar a versão do idioma no arquivo de definição do fluxo de trabalho CWL. Para obter mais informações sobre o CWL, consulte o guia do usuário do CWL

Suporte à versão Nextflow

HealthOmics suporta três versões estáveis do Nextflow. O Nextflow normalmente lança uma versão estável a cada seis meses. HealthOmics não suporta os lançamentos mensais “edge”.

HealthOmics oferece suporte aos recursos lançados em cada versão, mas não aos recursos de pré-visualização.

Versões aceitas

HealthOmics suporta as seguintes versões do Nextflow:

• Nextflow v22.04.01 DSL 1 e DSL 2

• Nextflow v23.10.0 DSL 2 (padrão)

• Nextflow v24.10.8 DSL 2

Para migrar seu fluxo de trabalho para a versão mais recente compatível (v24.10.8), siga o guia de atualização do Nextflow.

Há algumas mudanças importantes ao migrar do Nextflow v23 para a v24, conforme descrito nas seções a seguir do guia de migração do Nextflow:

• Mudanças recentes em 24.04

• Alterações de última hora em 24.10

Detecte e processe versões do Nextflow

HealthOmics detecta a versão DSL e a versão do Nextflow que você especifica. Ele determina automaticamente a melhor versão do Nextflow a ser executada com base nessas entradas.

Versão DSL

HealthOmics detecta a versão DSL solicitada no arquivo de definição do fluxo de trabalho. Por exemplo, você pode especificar:nextflow.enable.dsl=2.

HealthOmics suporta DSL 2 por padrão. Ele fornece compatibilidade com versões anteriores do DSL 1, se especificado no arquivo de definição do fluxo de trabalho.

• Se você especificar DSL 2, HealthOmics executará o Nextflow v23.10.0, a menos que você especifique o Nextflow v22.04.0 ou v24.10.8.

• Se você especificar DSL 1, HealthOmics executa o Nextflow v22.04 DSL1 (a única versão compatível que executa DSL 1).

• Se você não especificar uma versão da DSL ou se não HealthOmics conseguir analisar as informações da DSL por qualquer motivo (como erros de sintaxe no arquivo de definição do fluxo de trabalho), o HealthOmics padrão é DSL 2 e executa o Nextflow v23.10.0.

• Para atualizar seu fluxo de trabalho do DSL 1 para o DSL 2 e aproveitar as versões mais recentes do Nextflow e os recursos do software, consulte Migração do DSL 1.

Versões do Nextflow

HealthOmics detecta a versão solicitada do Nextflow no arquivo de configuração do Nextflow (nextflow.config), se você fornecer esse arquivo. Recomendamos que você adicione a nextflowVersion cláusula no final do arquivo para evitar substituições inesperadas das configurações incluídas. Para obter mais informações, consulte Configuração do Nextflow.

Você pode especificar uma versão do Nextflow ou um intervalo de versões usando a seguinte sintaxe:

   // exact match
   manifest.nextflowVersion = '1.2.3'   
            
   // 1.2 or later (excluding 2 and later)
   manifest.nextflowVersion = '1.2+'         
            
   // 1.2 or later
   manifest.nextflowVersion = '>=1.2'
            
   // any version in the range 1.2 to 1.5
   manifest.nextflowVersion = '>=1.2, <=1.5' 
            
   // use the "!" prefix to stop execution if the current version 
   // doesn't match the required version.
   manifest.nextflowVersion = '!>=1.2'            

HealthOmics processa as informações da versão do Nextflow da seguinte forma:

• Se você usar = para especificar uma versão exata que HealthOmics ofereça suporte, HealthOmics use essa versão.

• Se você usar ! para especificar uma versão exata ou um intervalo de versões que não são suportadas, HealthOmics gera uma exceção e falha na execução. Considere usar essa opção se quiser ser rigoroso com as solicitações de versão e falhar rapidamente se a solicitação incluir versões sem suporte.

• Se você especificar um intervalo de versões, HealthOmics usa a versão mais recente compatível nesse intervalo, a menos que o intervalo inclua v24.10.8. Nesse caso, HealthOmics dá preferência a uma versão anterior. Por exemplo, se o intervalo abranger v23.10.0 e v24.10.8, escolha v23.10.0. HealthOmics

• Se não houver uma versão solicitada ou se as versões solicitadas não forem válidas ou não puderem ser analisadas por algum motivo:

  • Se você especificou DSL 1, HealthOmics executa o Nextflow v22.04.

  • Caso contrário, HealthOmics executa o Nextflow v23.10.0.

Você pode recuperar as seguintes informações sobre a versão do Nextflow HealthOmics usada para cada execução:

• Os registros de execução contêm informações sobre a versão real do Nextflow HealthOmics usada para a execução.

• HealthOmics adiciona avisos nos registros de execução se não houver uma correspondência direta com a versão solicitada ou se for necessário usar uma versão diferente da especificada.

• A resposta à operação da GetRun API inclui um campo (engineVersion) com a versão real do Nextflow HealthOmics usada para a execução. Por exemplo:

  "engineVersion":"22.04.0"