Bioconductor / GenomicRanges

Representation and manipulation of genomic intervals
https://bioconductor.org/packages/GenomicRanges
41 stars 17 forks source link

Document and export get_out_of_bound_index #53

Open rpolicastro opened 3 years ago

rpolicastro commented 3 years ago

Hello,

The internal function get_out_of_bound_index is handy for getting the index of out-of-bounds ranges. I think people would find common use for it if it was documented and exported.

Cheers!

hpages commented 3 years ago

Hi @rpolicastro ,

What's your use case? My approach is to export and document this kind of low-level helper function only if there's a need for it.

Thanks, H.

rpolicastro commented 3 years ago

Hello @hpages,

My use was prompted by an old answer to a bioconductor post you made here.

I have ranges of variable width I want to extend, and then remove any that result in out-of-bounds ranges. There are of course ways to do so without this function, but the function was both simple and convenient.

I ended up copy/pasting the code for it into my own repo, but of course it would be better if the function itself was exported to avoid code duplication.

Cheers, Bob