Skip to content

dalmolingroup/MicroView

Repository files navigation

MicroView

license pytest status Documentation Status

MicroView, a reporting tool for taxonomic classification

MicroView agreggates results from taxonomic classification tools, such as Kaiju and Kraken, building an interactive HTML report with insightful visualizations.

Checkout the full documentation.

Quickstart

Install the package:

pip install microview

Alternatively, you can also install it with Conda:

conda install bioconda:microview

Go to your directory containing Kaiju/Kraken-style results and run:

microview -t .

Alternatively, if you have a CSV table defining result paths and contrasts, like this:

sample,group
result_1.tsv,group_one
result_2.tsv,group_two
...etc...

You can run MicroView like this:

microview -df contrast_table.csv -o report_with_table.html

Then, an HTML file named microview_report.html - or the name you defined with the -o param - should be available in your working directory, try opening it with your browser!

Example report

Here's what the beginning of a MicroView report looks like (sensitive information obscured):

MicroView header