nvictus/pybbi

bbi.stackup doesn't error with intervals of different lengths

Snehal1894 opened this issue · 3 comments

I used bbi.stackup fuction with varying intervals and it gave me valid a 2D numpy array without throwing any error, when it mentioned that it works with equal intervals.

Thanks. I actually dropped this requirement a while ago, but it looks like the docstring wasn't updated to reflect it. Specifically, if the bins= argument is used, the intervals can have any length, since each interval can be rescaled to the same number of bins.

It's actually a feature rather than a bug (e.g. to rescale genes to a standardized length), but maybe there should be some guardrails to prevent this from accidentally happening when one thinks that one's intervals all have the same length.

Behavior is clarified in the docstring in #28.

Hello! That's a nice feature of interpolating a signal. Could you please also add this clarification to the repo's Readme? Some users usually refer to that rather than to docstrings.