🐲
Illumina Infectious Disease Software
Illumina Connected Software
  • 👾Illumina Infectious Disease and Microbiology Software
  • DRAGEN Microbial Amplicon
    • ▶️DRAGEN Microbial Amplicon App Documentation
      • 🌀How to start
      • Page
      • 🧬Custom reference
        • 📄Reference BED file format
        • 📄PCR Primer definition file formats
      • 📂Output files
      • 📖Understanding the BaseSpace Reports
        • 📄Summary
        • 📄Sample Report
      • 💠Pipeline Logic
      • ⭐Special considerations for amplicon detection
      • ❓Frequently Asked Questions (FAQ)
  • DRAGEN Targeted Microbial
    • ▶️DRAGEN Targeted Microbial App Documentation
      • 🌀How to set up and run an analysis
      • 🧬Custom genomes and primer sets
        • 📄Genome definition file formats
        • 📄Primer definition file formats
      • ⚙️App Settings
      • 📖Understanding the BaseSpace Reports
        • 📄Summary Report
        • 📄Result Reports
      • 📂Output files
      • 💠Pipeline Logic
      • ⭐Special considerations for amplicon sequencing with IMAP protocols
      • ❓Frequently Asked Questions (FAQ)
      • 🚩Known issues
  • DRAGEN Microbial Enrichment Plus
    • ▶️DRAGEN Microbial Enrichment Plus App Documentation
      • 🌀How to set up and run an analysis
        • 🧬Custom reference FASTA and BED files
        • 📄Microorganism Reporting File format
      • 📂Output files
        • 📖Understanding the BaseSpace HTML reports
        • 📖Report JSON format
      • 💠Pipeline logic
      • ⭐Test information
        • 📄RPIP
        • 📄UPIP
        • 📄RVOP/RVEK
        • 📄VSP
        • 📄VSP V2
        • 📄Custom Panel
      • 🕵️‍♀️Scientific evidence
      • ❓Frequently Asked Questions (FAQ)
      • 🚩Release notes
Powered by GitBook
On this page
  • How to edit the template file
  • Example user-defined microorganism reporting file

Was this helpful?

Export as PDF
  1. DRAGEN Microbial Enrichment Plus
  2. DRAGEN Microbial Enrichment Plus App Documentation
  3. How to set up and run an analysis

Microorganism Reporting File format

PreviousCustom reference FASTA and BED filesNextOutput files

Last updated 6 months ago

Was this helpful?

Enrichment panel
Template file

How to edit the template file

  1. First, we recommend saving the provided template file with a new name

  2. Do not add any new columns and do not delete any columns from the template file

  3. Do not change or remove any text from the header row. **The "kmer_read_count" metric is only valid with the UPIP enrichment panel.

  4. Rows with microorganism names that are not of interest can be deleted. However, the entire tiered reporting group for certain viruses must be included to preserve tiered reporting logic (if desired). Membership in a tiered reporting group means that a hierarchical relationship is pre-built into the database and the most granular tier level passing reporting thresholds is reported. For example, if Influenza B virus (B/Victoria/2/87-like) or Influenza B virus (B/Yamagata/16/88-like) are reported in a sample then the less granular Influenza B virus reporting name will NOT be reported. See the "Has Tiered Reporting" and "Reporting Tier" columns of the "Microorganisms" table in the for RPIP, RVOP/RVEK, VSP, and VSP V2 to select and see which viruses are reported as part of a tiered reporting group.

  5. Upload the microorganism reporting file to a BaseSpace Project. **It is only necessary to upload the file once.

  6. Select the file by clicking on the "Dataset File(s)" option under the "User-defined specification" section.

Example user-defined microorganism reporting file

See example below for 6 RPIP microorganism reporting names. Prediction logic can be specified on a microorganism-by-microorganism basis using multiple parameters and combinatorial logical expressions.

reporting_name
prediction_logic
coverage
median_depth
ani
aligned_read_count
rpkm
kmer_read_count

Acinetobacter baumannii

default

Cryptococcus neoformans

coverage

0.3

Escherichia coli

aligned_read_count

200

Human adenovirus E

(coverage AND median_depth) OR (aligned_read_count AND ani)

0.1

1

0.95

100

Human bocavirus 1 (HBoV1)

rpkm OR (ani AND coverage) OR median_depth

0.2

5

0.9

5

Klebsiella pneumoniae

default AND coverage

0.5

▶️
🌀
📄
Illumina Respiratory Pathogen ID/AMR Enrichment Panel Kit (RPIP)
Illumina Urinary Pathogen ID/AMR Enrichment Panel Kit (UPIP)
Illumina Respiratory Virus Oligo Panel / Respiratory Virus Enrichment Kit (RVOP / RVEK)
Illumina Viral Surveillance Panel (VSP)
Illumina Viral Surveillance Panel V2 (VSP V2)
Panel Summary
RPIP_6-5-1_Microorganism_Reporting_Template.xlsx
UPIP_8-6-0_Microorganism_Reporting_Template.xlsx
RVOP_2-7-0_Microorganism_Reporting_Template.xlsx
VSP_2-7-0_Microorganism_Reporting_Template.xlsx
VSPV2_2-7-0_Microorganism_Reporting_Template.xlsx