Support de version pour les langages HealthOmics de définition des flux de travail

HealthOmics prend en charge les fichiers de définition de flux de travail écrits en Nextflow, WDL ou CWL. Les sections suivantes fournissent des informations sur HealthOmics la prise en charge des versions pour ces langues.

Support des versions WDL

HealthOmics prend en charge les versions 1.0, 1.1 et la version de développement de la spécification WDL.

Chaque document WDL doit inclure une déclaration de version pour spécifier la version (majeure et mineure) de la spécification à laquelle il adhère. Pour plus d'informations sur les versions, voir Gestion des versions WDL

Les versions 1.0 et 1.1 de la spécification WDL ne prennent pas en charge ce Directory type. Pour utiliser le Directory type pour les entrées ou les sorties, définissez la development version sur la première ligne du fichier :

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

Support de la version CWL

HealthOmics supporte les versions 1.0, 1.1 et 1.2 du langage CWL.

Vous pouvez spécifier la version linguistique dans le fichier de définition du flux de travail CWL. Pour plus d'informations sur CWL, consultez le guide de l'utilisateur de CWL

Support de la version Nextflow

HealthOmics supporte trois versions stables de Nextflow. Nextflow publie généralement une version stable tous les six mois. HealthOmics ne prend pas en charge les versions mensuelles « Edge ».

HealthOmics prend en charge les fonctionnalités publiées dans chaque version, mais pas les fonctionnalités de prévisualisation.

Versions prises en charge

HealthOmics prend en charge les versions suivantes de Nextflow :

• Nextflow v22.04.01 DSL 1 et DSL 2

• Nextflow v23.10.0 DSL 2 (par défaut)

• Nextflow v24.10.8 DSL 2

Pour migrer votre flux de travail vers la dernière version prise en charge (v24.10.8), suivez le guide de mise à niveau de Nextflow.

La migration de Nextflow v23 vers v24 entraîne des modifications majeures, comme décrit dans les sections suivantes du guide de migration de Nextflow :

• Changements les plus marquants de la version 24.04

• Changements majeurs dans la version 24.10

Détecter et traiter les versions de Nextflow

HealthOmics détecte la version DSL et la version Nextflow que vous spécifiez. Il détermine automatiquement la meilleure version de Nextflow à exécuter en fonction de ces entrées.

Version DSL

HealthOmics détecte la version DSL demandée dans votre fichier de définition de flux de travail. Par exemple, vous pouvez spécifier :nextflow.enable.dsl=2.

HealthOmics prend en charge le DSL 2 par défaut. Il fournit une rétrocompatibilité avec DSL 1, si cela est spécifié dans le fichier de définition de votre flux de travail.

• Si vous spécifiez DSL 2, HealthOmics exécute Nextflow v23.10.0, sauf si vous spécifiez Nextflow v22.04.0 ou v24.10.8.

• Si vous spécifiez DSL 1, HealthOmics exécute Nextflow v22.04 DSL1 (la seule version prise en charge qui exécute DSL 1).

• Si vous ne spécifiez pas de version DSL, ou si HealthOmics vous ne parvenez pas à analyser les informations DSL pour quelque raison que ce soit (par exemple, des erreurs de syntaxe dans le fichier de définition de votre flux de travail), utilisez HealthOmics par défaut DSL 2 et exécutez Nextflow v23.10.0.

• Pour mettre à niveau votre flux de travail du DSL 1 au DSL 2 afin de tirer parti des dernières versions et fonctionnalités logicielles de Nextflow, voir Migration depuis DSL 1.

Versions de Nextflow

HealthOmics détecte la version de Nextflow demandée dans le fichier de configuration de Nextflow (nextflow.config), si vous fournissez ce fichier. Nous vous recommandons d'ajouter la nextflowVersion clause à la fin du fichier pour éviter tout remplacement inattendu des configurations incluses. Pour plus d'informations, consultez la section Configuration de Nextflow.

Vous pouvez spécifier une version de Nextflow ou une série de versions à l'aide de la syntaxe suivante :

   // 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 traite les informations de version de Nextflow comme suit :

• Si vous spécifiez une version exacte qui HealthOmics prend en charge, HealthOmics utilise cette version. =

• Si vous ! spécifiez une version exacte ou une plage de versions qui ne sont pas prises en charge, HealthOmics déclenche une exception et échoue. Envisagez d'utiliser cette option si vous souhaitez être strict en ce qui concerne les demandes de version et échouer rapidement si la demande inclut des versions non prises en charge.

• Si vous spécifiez une plage de versions, HealthOmics utilise la dernière version prise en charge dans cette plage, sauf si la plage inclut la version 24.10.8. Dans ce cas, HealthOmics donne la préférence à une version antérieure. Par exemple, si la plage couvre à la fois les versions 23.10.0 et 24.10.8, choisissez la version 23.10.0. HealthOmics

• S'il n'existe aucune version demandée, ou si les versions demandées ne sont pas valides ou ne peuvent pas être analysées pour une quelconque raison :

  • Si vous avez spécifié DSL 1, HealthOmics exécute Nextflow v22.04.

  • Sinon, HealthOmics exécute Nextflow v23.10.0.

Vous pouvez récupérer les informations suivantes concernant la version de Nextflow HealthOmics utilisée pour chaque exécution :

• Les journaux d'exécution contiennent des informations sur la version réelle de Nextflow HealthOmics utilisée pour l'exécution.

• HealthOmics ajoute des avertissements dans les journaux d'exécution s'il n'y a pas de correspondance directe avec la version demandée ou s'il est nécessaire d'utiliser une version différente de celle que vous avez spécifiée.

• La réponse à l'opération d'GetRunAPI inclut un champ (engineVersion) avec la version réelle de Nextflow HealthOmics utilisée pour l'exécution. Par exemple :

  "engineVersion":"22.04.0"