search

BioJulia / XAM.jl

Parse and process SAM and BAM formatted files
MIT License
27 stars 13 forks source link

Has flag() renamed to flags()? #73

Open egoecho opened 2 months ago

egoecho commented 2 months ago

When I ran a previous code I faced an error, since BAM.flag() function no longer existed. I found these was other undocumented function XAM.flags(). It seems XAM.flags() behaves identically to the previous BAM.flag() function after a try. Is that XAM.flags() is just a rename of BAM.flag() in the current and future versions, or is there another "formal" way I should use to access the flags data of read mapping information? Thank you!

kescobo commented 2 months ago

Looks like this: https://github.com/BioJulia/XAM.jl/blame/develop/src/flags.jl#L27 from @CiaranOMara , and it appears to me that the answer to

Is that XAM.flags() is just a rename of BAM.flag() in the current and future versions

is "yes". And it looks like the function IS documented in the source, but maybe wasn't updated in the documenter build?