merenlab / anvio

An analysis and visualization platform for 'omics data
http://merenlab.org/software/anvio
GNU General Public License v3.0
423 stars 144 forks source link

[FEATURE REQUEST] Documentation for metabolic reaction network toolkit #2124

Closed meren closed 11 months ago

meren commented 11 months ago

The need

For the new toys in our codebase made available through the heroic efforts of @semiller10 via #2123, we need,

The solution

Addressing the following concerns would be the best solution.

Docs

Here are some of the artifacts and programs that need love:

Component tests

Beneficiaries

Anvi'o users who are interested in understanding how to use these tools effectively :)

semiller10 commented 11 months ago

Some of the documentation was stored in files without the requisite .md extension, but I fleshed it out a lot more with the help of your handy checklist.

I added reaction network tests to the metabolism self-test suite.

meren commented 11 months ago

You are the absolute best, Sam. Thank you very much.