NF-Validierung

Ein Nextflow-Plugin zur Arbeit mit der Validierung von Pipeline-Parametern und Beispielblättern.

Wichtig

nf-validation wurde jetzt in nf-schema umbenannt.

Das nf-validation -Plugin wird keine zukünftigen Updates erhalten. Bitte aktualisieren Sie Ihre Pipelines, um stattdessen nf-schema zu verwenden.

Weitere Informationen finden Sie unter https://github.com/nextflow-io/nf-schema.

Diese Änderung war notwendig, um zu verhindern, dass ältere Versionen von nf-core -Pipelines mit nicht angehefteten Plugin-Referenzen beim Aktualisieren auf die neueste Version von nf-validation kaputt gehen. Bitte pinnen Sie die Version von nf-schema in der Datei nextflow.config Ihrer Pipeline an:

plugins { id ' [email protected] ' }

Einführung

Dieses Nextflow-Plugin bietet eine Reihe von Funktionen, die in ein Nextflow-Pipeline-Skript eingebunden werden können, um mit Parametern und Beispielblattschemata zu arbeiten. Mit diesen Funktionen können Sie:

• ? Gebrauchsanweisungen auf das Terminal drucken (zur Verwendung mit --help )
• ✍️ Drucken Sie die Protokollausgabe mit Parametern mit nicht standardmäßigen Werten
• ✅ Validieren Sie die bereitgestellten Parameter anhand des Pipeline-Schemas
• ? Validieren Sie den Inhalt der bereitgestellten Beispielblattdateien
• ?️ Erstellen Sie einen Nextflow-Kanal mit einem geparsten Beispielblatt

Unterstützte Beispielblattformate sind CSV, TSV und YAML (einfach).

Schnellstart

Deklarieren Sie das Plugin in Ihrer Nextflow-Pipeline-Konfigurationsdatei:

plugins {
  id ' nf-validation '
}

Das ist alles, was benötigt wird – Nextflow ruft den Plugin-Code zur Laufzeit automatisch ab.

Notiz

Das obige Snippet versucht immer, die neueste Version zu installieren. Stellen Sie sicher, dass die neuesten Fehlerbehebungen enthalten sind! Dies kann jedoch bei der Offline-Ausführung zu Schwierigkeiten führen. Sie können eine bestimmte Version mit der Syntax [email protected] anpinnen

Sie können jetzt die Plugin-Hilfsfunktionen in Ihre Nextflow-Pipeline einbinden:

include { validateParameters; paramsHelp; paramsSummaryLog; fromSamplesheet } from ' plugin/nf-validation '

// Print help message, supply typical command line usage for the pipeline
if (params . help) {
   log . info paramsHelp( " nextflow run my_pipeline --input input_file.csv " )
   exit 0
}

// Validate input parameters
validateParameters()

// Print summary of supplied parameters
log . info paramsSummaryLog(workflow)

// Create a new channel of metadata from a sample sheet
// NB: `input` corresponds to `params.input` and associated sample sheet schema
ch_input = Channel . fromSamplesheet( " input " )

Abhängigkeiten

• Java 11 oder höher
• https://github.com/everit-org/json-schema

Slack-Kanal

Im Nextflow Slack-Arbeitsbereich gibt es einen dedizierten Slack-Kanal für die NF-Validierung.

Credits

Dieses Plugin wurde auf der Grundlage von Code geschrieben, der ursprünglich innerhalb der NF-Core-Community als Teil der NF-Core-Pipeline-Vorlage geschrieben wurde.

Wir möchten uns bei den wichtigsten Mitwirkenden bedanken, zu denen unter anderem gehören:

• Júlia Mir Pedrol (@mirpedrol)
• Nicolas Vannieuwkerke (@nvnieuwk)
• Kevin Menden (@KevinMenden)
• Phil Ewels (@ewels)