Skip to content

Pipepline for the standard quantification of microbial guilds from metagenomic samples.

License

Notifications You must be signed in to change notification settings

pyubero/microguilds

Repository files navigation

microguilds

Welcome to microguilds 🎉 Microguilds is a python project that aims to simplify and automate the analysis of microbial guilds given metagenomic samples (or other types of data). Recall that an ecological guild is composed of individuals that exploit a key resource space despite exploiting it differently (with different implemented functions).

Contents

This repo is divided into three different aspects related to microbial guild analysis:

  1. functional_clustering: contains all scripts related with the clustering of a tree's branches given some environmental data. In this way we distinguish, in a meaningful way, between implementations of a function that have adapted to specific environmental features. More info.
  2. guild_tensors: once the different functional implementations have been identified, we can quantitatively characterize the contribution of taxons and implementations to a microbial guild across different environmental contexts. These scripts help quantify, visualize and analyze microbial guilds. More info
  3. [obsolete] sequence_fetcher from NCBI's databases: the idea is that given a list of organisms in plain text file, you can automatically retrieve the sequence of any gene using either NCBI's assemblies or E-tools. More info.

Installation

To use migroguilds you don't need to install anything (for now it is not meant to be a package) but rather a collection of useful functions or cli applications. Simply clone this repo and start running our own developped applications or write your own!

  • To clone the repository use: git clone https://github.com/pyubero/microguilds.git

Tutorials

For a better experience, we have create some tutorials on how we personally use the functions available in this repo. They are somewhat deeply commented examples using mock organisms and a mock mastertable.

Contributing and bug reports 🐛

We are always looking for people interested in helping with code development, documentation... If you wish to contribute, please first send any of us an email.

If you find any bug please do not hesitate to open an issue.

License

This code is offered under a GNU General Public License v3.0.

Citation

Please cite the following paper for academic references:

Rivas-Santisteban, J., Yubero, P., Robaina-Estévez, S., González, J. M., Tamames, J., & Pedrós-Alió, C. (2024). Quantifying microbial guilds. ISME Communications, 4(1), ycae042.

or bibtex

@article{rivas2024quantifying,
  title={Quantifying microbial guilds},
  author={Rivas-Santisteban, Juan and Yubero, Pablo and Robaina-Est{\'e}vez, Semid{\'a}n and Gonz{\'a}lez, Jos{\'e} M and Tamames, Javier and Pedr{\'o}s-Ali{\'o}, Carlos},
  journal={ISME Communications},
  volume={4},
  number={1},
  pages={ycae042},
  year={2024},
  publisher={Oxford University Press}
}

Credits

microguilds mainly involves Juan Rivas and Pablo Yubero (both PhD students at CNB, Madrid).