การตรวจสอบความถูกต้อง

ปลั๊กอิน Nextflow เพื่อทำงานกับการตรวจสอบพารามิเตอร์ไปป์ไลน์และแผ่นงานตัวอย่าง

สำคัญ

ตอนนี้เปลี่ยนชื่อเป็น nf-validation เป็น nf-schema แล้ว

ปลั๊กอิน nf-validation จะไม่ได้รับการอัปเดตใดๆ ในอนาคต โปรดอัปเดตไปป์ไลน์ของคุณเพื่อใช้ nf-schema แทน

ดูhttps://github.com/nextflow-io/nf-schemaสำหรับรายละเอียด

การเปลี่ยนแปลงนี้มีความจำเป็นเพื่อป้องกันไม่ให้ไปป์ไลน์ nf-core เวอร์ชันเก่าที่มีการอ้างอิงปลั๊กอินที่ไม่ได้ปักหมุดเสียหายเมื่ออัปเดตเป็นเวอร์ชันล่าสุดของ nf-validation โปรดปักหมุดเวอร์ชันของ nf-schema ในไฟล์ nextflow.config ของไปป์ไลน์ของคุณ:

plugins { id ' [email protected] ' }

การแนะนำ

ปลั๊กอิน Nextflow นี้มีฟังก์ชันจำนวนหนึ่งที่สามารถรวมไว้ในสคริปต์ไปป์ไลน์ Nextflow เพื่อทำงานกับพารามิเตอร์และสคีมาแผ่นงานตัวอย่าง การใช้ฟังก์ชันเหล่านี้ทำให้คุณสามารถ:

• - พิมพ์คำแนะนำการใช้งานไปยังเทอร์มินัล (สำหรับใช้กับ --help )
• ✍️ พิมพ์บันทึกเอาต์พุตที่แสดงพารามิเตอร์ด้วยค่าที่ไม่ใช่ค่าเริ่มต้น
• ✅ ตรวจสอบพารามิเตอร์ที่ให้มากับไปป์ไลน์สคีมา
• - ตรวจสอบเนื้อหาของไฟล์แผ่นตัวอย่างที่ให้มา
• ️ สร้างช่องทาง Nextflow ด้วยแผ่นตัวอย่างที่แยกวิเคราะห์

รูปแบบแผ่นงานตัวอย่างที่รองรับคือ CSV, TSV และ YAML (แบบง่าย)

เริ่มต้นอย่างรวดเร็ว

ประกาศปลั๊กอินในไฟล์การกำหนดค่าไปป์ไลน์ Nextflow ของคุณ:

plugins {
  id ' nf-validation '
}

นี่คือทั้งหมดที่จำเป็น - Nextflow จะดึงโค้ดปลั๊กอินโดยอัตโนมัติในขณะใช้งาน

บันทึก

ตัวอย่างด้านบนจะพยายามติดตั้งเวอร์ชันล่าสุดเสมอ เพื่อให้แน่ใจว่ามีการแก้ไขข้อบกพร่องล่าสุดรวมอยู่ด้วย! อย่างไรก็ตาม สิ่งนี้อาจทำให้เกิดปัญหาได้หากทำงานแบบออฟไลน์ คุณสามารถปักหมุดรุ่นเฉพาะได้โดยใช้ไวยากรณ์ [email protected]

ตอนนี้คุณสามารถรวมฟังก์ชันตัวช่วยปลั๊กอินลงในไปป์ไลน์ Nextflow ของคุณได้แล้ว:

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 " )

การพึ่งพาอาศัยกัน

• ชวา 11 หรือใหม่กว่า
• https://github.com/everit-org/json-schema

ช่องหย่อน

มีช่องทาง Slack สำหรับการตรวจสอบ nf โดยเฉพาะในพื้นที่ทำงาน Nextflow Slack

เครดิต

ปลั๊กอินนี้เขียนขึ้นตามโค้ดที่เขียนครั้งแรกภายในชุมชน nf-core โดยเป็นส่วนหนึ่งของเทมเพลตไปป์ไลน์ nf-core

เราขอขอบคุณผู้มีส่วนร่วมหลักซึ่งรวมถึง (แต่ไม่จำกัดเพียง):

• จูเลีย มีร์ เปโดรล (@mirpedrol)
• นิโคลัส แวนเนียวเคอร์เก (@nvnieuwk)
• เควิน เมนเดน (@KevinMenden)
• ฟิล เอเวลส์ (@ewels)