From c1502a93f98d3ff2ccfb4f97a7a00c616e8fcf16 Mon Sep 17 00:00:00 2001 From: fabiosanchez Date: Tue, 26 Mar 2024 19:42:03 -0300 Subject: [PATCH] Update README.md --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 01c553c..fa2b54b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,41 @@ -# Welcome to MAGset -MAGset is a tool to analyze genomes obtained from metagenomic data (MAGs) of known species (which have published reference genomes). +

Welcome to the MAGset wiki!

+MAGset is a tool to analyze genomes obtained from metagenomic data (MAGs) of known species (which have published reference genomes).

-Please open the Wiki (https://github.com/LaboratorioBioinformatica/MAGset/blob/master/wiki/README.md) for more information +The main goal is to find the differences between the genomes and identify the genomic regions of interest (GRIs) that exist in the MAG but don't exist in any reference genome (positive GRIs) and genomic regions of interest that exist in one or more reference genomes, but they don't exist in the MAG (negative GRIs). Negative GRIs can be caused by assembly errors, and using the MAGcheck module you can search for them in your raw data. + +

The tool generates the following results:

+ +* ANI matrix between genomes; +* Pangenome (specific, shared and core genes); +* Identification of genomic regions of interest (GRIs); +* COGs and CAZy annotations; +* Advanced search of genes by gene data; +* Validation of MAG assembly using raw data vs references genomes; + +

All results are generated in HTML.

+ +**MAgset Pipeline:** + +![Pipeline](/wiki/pipeline.png) + +**Screenshot from a MAGset result:** + +![Home result page](/wiki/home-sample-result-index.png) + +

Please use the links below to learn more about the MAGset:

+ +* [How to install](/wiki/How-to-install.md) +* [Quick start](/wiki/Quick-start.md) +* [What is Genomic Regions of Interest (GRIs)?](/wiki/Genomic-Region-Of-Interest.md) +* [Tutorial - GBFF files as input](/wiki/tutorial-gbff-files-as-input.md) +* [Tutorial - How to use the advanced gene search](/wiki/tutorial-advanced-gene-search.md) +* [Tutorial - Using MAGcheck](/wiki/tutorial-using-magcheck.md) +* [Input files](/wiki/Input-files.md) +* [Output files](/wiki/Output-files.md) +* [Parameters](/wiki/Parameters.md) + +## Acknowledgements +This project was funded in part by [CNPq](https://www.gov.br/cnpq/pt-br), grant number 440230/2022-5, within the Call CNPq/MCTI/CT-Biotec number 30/2022 + +## Article / How to cite +Coming soon!