|
1 | 1 | # mi-atlas: a Microbial Interactions Atlas <img src="docs/content/extra/logo.png" align="right" width="155" height="179"/>
|
2 | 2 |
|
3 |
| -## Rationale |
| 3 | +## Description |
4 | 4 |
|
5 | 5 | A framework was recently suggested to describe interactions occurring between microorganisms using the encoding of several (binary) features in order to build a catalog amenable to quantitative analyses ([Pacheco and Segrè, 2019](https://doi.org/10.1093/femsle/fnz125)).
|
6 | 6 | Their initial effort described 74 interactions which were unfortunately available only in the Supplementary Material section of the article.
|
7 |
| -Therefore, the objective of [mi-atlas](https://github.com/cpauvert/mi-atlas) (pronounced `/'mi atlas/` like in Spanish) is two-fold: |
| 7 | +Therefore, [mi-atlas](https://github.com/cpauvert/mi-atlas) (pronounced `/'mi atlas/` like in Spanish) aims to: |
8 | 8 |
|
9 |
| -1. browse interactively the catalog |
| 9 | +1. propose an interactive exploration of the catalog and |
10 | 10 | 2. enable versioned community contributions to the microbial interactions catalog
|
11 | 11 |
|
12 |
| -To do so, this project will rely on a Shiny application to render the multi-column catalog into human-readable entries upon selection of the interaction of interest. |
13 |
| -Contributions to the catalog will be possible through the use of the system already in place in Github: [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). |
14 |
| -New entries could then be discussed and reviewed before acceptance using the [pull request review](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews#about-pull-request-reviews). |
| 12 | +## Contributing |
15 | 13 |
|
16 |
| -A builder will be designed to ease the addition of a new entry to the catalog that follows the framework guidelines. |
| 14 | +Contributions to the catalog in the form of corrections and/or new entries are welcome and possible. If you are interested, please have a look at the [CONTRIBUTING guidelines](CONTRIBUTING.md). |
| 15 | + |
| 16 | +## Expected developments |
| 17 | + |
| 18 | +Several [milestones](https://github.com/cpauvert/mi-atlas/milestones) are already set for incremental improvements of the two aims of the project. |
| 19 | + |
| 20 | +*Spoiler alert*: a Shiny application will be used to render the multi-column catalog into human-readable entries upon selection of the interaction of interest. |
| 21 | +In the future, a builder will be designed to ease the addition of a new entry to the catalog that follows the framework guidelines. |
| 22 | +And ideally new entries could be discussed and reviewed before acceptance using the [pull request review](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews#about-pull-request-reviews) system. |
17 | 23 |
|
18 | 24 | ## Reference
|
19 | 25 |
|
|
0 commit comments