> For the complete documentation index, see [llms.txt](https://help.idm.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.idm.illumina.com/dragen-microbial-enrichment-plus/dragen-microbial-enrichment-plus/how-to-set-up-and-run-an-analysis/microorganism-reporting-file-format.md).

# Microorganism Reporting File format

<table><thead><tr><th>Enrichment panel</th><th data-type="files">Template file</th></tr></thead><tbody><tr><td><a href="https://www.illumina.com/products/by-type/sequencing-kits/library-prep-kits/respiratory-pathogen-id-panel.html">Illumina Respiratory Pathogen ID/AMR Enrichment Panel Kit (RPIP)</a></td><td><a href="/files/KCxqWz1M0yX0vo3nLFhh">/files/KCxqWz1M0yX0vo3nLFhh</a></td></tr><tr><td><a href="https://www.illumina.com/products/by-type/sequencing-kits/library-prep-kits/urinary-pathogen-id-amr-enrichment-kit.html">Illumina Urinary Pathogen ID/AMR Enrichment Panel Kit (UPIP)</a></td><td><a href="/files/n117INjRtqFwdSvaFfMZ">/files/n117INjRtqFwdSvaFfMZ</a></td></tr><tr><td><a href="https://www.illumina.com/products/by-type/sequencing-kits/library-prep-kits/respiratory-virus-oligo-panel.html">Illumina Respiratory Virus Oligo Panel / Respiratory Virus Enrichment Kit (RVOP / RVEK)</a></td><td><a href="/files/QAyrR4WtJahEUUrecEzF">/files/QAyrR4WtJahEUUrecEzF</a></td></tr><tr><td><a href="https://www.illumina.com/products/by-type/sequencing-kits/library-prep-kits/viral-surveillance-panel.html">Illumina Viral Surveillance Panel (VSP)</a></td><td><a href="/files/bkmJgMUfVy07QlbPzIaK">/files/bkmJgMUfVy07QlbPzIaK</a></td></tr><tr><td><a href="https://www.illumina.com/products/by-type/sequencing-kits/library-prep-kits/viral-surveillance-panel.html">Illumina Viral Surveillance Panel V2 (VSP V2)</a></td><td><a href="/files/wgTxyuKqWagz7VxEfy37">/files/wgTxyuKqWagz7VxEfy37</a></td></tr></tbody></table>

## 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 [Panel Summary](/dragen-microbial-enrichment-plus/dragen-microbial-enrichment-plus.md#supported-hybrid-capture-enrichment-panels) 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      |               |      |                      |      |                   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.idm.illumina.com/dragen-microbial-enrichment-plus/dragen-microbial-enrichment-plus/how-to-set-up-and-run-an-analysis/microorganism-reporting-file-format.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
