XAM.jl icon indicating copy to clipboard operation
XAM.jl copied to clipboard

Has flag() renamed to flags()?

Open egoecho opened this issue 1 year ago • 1 comments

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!

egoecho avatar May 22 '24 11:05 egoecho

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?

kescobo avatar May 23 '24 16:05 kescobo