tlemane / kmtricks

modular k-mer count matrix and Bloom filter construction for large read collections
GNU Affero General Public License v3.0
77 stars 7 forks source link

Clarification suggestion #19

Closed pashadag closed 1 year ago

pashadag commented 2 years ago

kmtricks uses a non-standard definition of canonical k-mer, because it treats T<G. This is mentioned in the usage of the aggregate command with sorted option, but its also relevant when the output is not sorted (because it defines what is the canonical k-mer). It could save future users some debugging time if this information was included in kmer dump help and kmer aggregate help (for non sorted option).

Just to clarify, I think you do have this information there already but it could help avoid user-error if it was featured more prominently in the help/usage.