search

Becksteinlab / kda

Python package used for the analysis of biochemical kinetic diagrams.
GNU General Public License v3.0
3 stars 1 forks source link

DOC: Add algorithm references to function docstrings #65

Closed nawtrey closed 1 week ago

nawtrey commented 2 years ago

When the pseudocode algorithms are finished for the partial, directional, and flux diagram generation functions it would be good to add references to these in the corresponding docstrings.

nawtrey commented 3 weeks ago

This is probably best handled once the KDA paper is published so I can add the actual citation to the documentation.

nawtrey commented 1 week ago

With https://github.com/Becksteinlab/kda/commit/61a1fcbd0aab22f0075a1438e0977af32ed1918f merged I think this issue is on the path to being closed. I've already spent some time working on changes for the partial diagrams algorithm, and the flux diagrams algo is likely to change soon as well, so I don't think adding these labels to the documentation will be of any real use.