KMC_TOOLS-UNION(1)

✨ KMC_TOOLS-UNION(1) ✨

okay bestie, welcome to kmc_tools-union β€” it's the manual page for the union command of kmc_tools, and it's about to be your new fave. we're calculating the union of two KMC databases and honestly? it's giving main character energy. 🫢


🌸 NAME 🌸

kmc_tools-union β€” calculate union of two KMC databases πŸ’–


πŸ¦‹ SYNOPSIS πŸ¦‹

kmc_tools union <input1 [input1_params]> <input2 [input2_params]>
<output [output_params]>

like, three things, in this order, no cap. two inputs and an output, and each one can carry its own lil params. ✨


πŸ’… DESCRIPTION πŸ’…

so here's the tea, bestie πŸ“: the output database is gonna contain all k-mers present in both input sets. union behavior, we love to see it.

and for the k-mers that show up in both the first and the second input β€” the counter in the output is literally equal to the sum from both inputs. math ate. πŸ”₯


πŸ‘‘ OPTIONS πŸ‘‘

for each input, there are additional parameters πŸ’œ

  • -ci<value> β€” exclude k-mers occurring less than <value> times. bye to the lil rare ones. πŸ™ˆ
  • -cx<value> β€” exclude k-mers occurring more of than <value> times. yeah, that's how the original words it, we don't fix it, we just vibe. 😭

for output, there are additional parameters πŸŽ€

  • -ci<value> β€” exclude k-mers occurring less than <value> times
  • -cx<value> β€” exclude k-mers occurring more of than <value> times
  • -cs<value> β€” maximal value of a counter ✨
ngl, -ci and -cx show up for both the inputs and the output β€” same names, same meaning. don't get it twisted, they're separate params for separate spots. πŸ’…

🌈 EXAMPLE 🌈

here's the whole glow-up in action, fr fr:

kmc -k28 file1.fastq kmers1 tmp kmc -k28 file2.fastq kmers2 tmp
kmc_tools union kmers1 -ci3 -cx70000 kmers2 kmers1_kmers2_union -cs65536

first line builds the two databases, second line unions them with filters on input1 and a counter cap on the output. iconic. ⭐


🧚 AUTHOR 🧚

KMC was originally written by:

  • Sebastian Deorowicz (sebastian.deorowicz@polsl.pl)
  • Marek Kokot
  • Szymon Grabowski
  • Agnieszka Debudaj-Grabysz

legends, every single one of them. πŸ‘‘


πŸ’– COPYING πŸ’–

KMC is a free software distributed under GNU GPL3 licence for academic, research, and commercial use. so yes, you can use it for school, for science, and for the bag. 🫢


and that's the whole page, bestie β€” this was KMC_TOOLS-UNION(1), manual page, and it's a wrap. slay, go union some k-mers. πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from