python API docs - Githubissues

open2c / pairtools

Extract 3D contacts (.pairs) from sequencing alignments

MIT License

98 stars 32 forks source link

python API docs #163

Open Phlya opened 1 year ago

Phlya commented 1 year ago

We should create them...

From highest priority to lowest:

[ ] io/header: https://github.com/open2c/pairtools/blob/master/pairtools/lib/headerops.py
[ ] scaling: https://github.com/open2c/pairtools/blob/master/pairtools/lib/scaling.py
[ ] stats: https://github.com/open2c/pairtools/blob/master/pairtools/lib/stats.py

agalitsyna commented 1 year ago

Currently, not all lib modules should be considered user-exposable APIs. Only io/header, scaling, and stats can be helpful when accessed from Python. Maybe we can document them; I agree! If you think other lib modules can be useful, feel free to add them.