Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiosanchez authored Mar 26, 2024
1 parent 33740f5 commit c1502a9
Showing 1 changed file with 40 additions and 3 deletions.
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
<h1>Welcome to the MAGset wiki!</h1>
MAGset is a tool to analyze genomes obtained from metagenomic data (MAGs) of known species (which have published reference genomes).<br/><br/>

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.

<p>The tool generates the following results:</p>

* 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;

<p>All results are generated in HTML.</p>

**MAgset Pipeline:**

![Pipeline](/wiki/pipeline.png)

**Screenshot from a MAGset result:**

![Home result page](/wiki/home-sample-result-index.png)

<p>Please use the links below to learn more about the MAGset: </p>

* [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!

0 comments on commit c1502a9

Please sign in to comment.