sand_filter_kernel(1)

πŸ“¦
version 9.9 Β· 3 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

✨ sand_filter_kernel ✨

okay bestie, welcome to the sand_filter_kernel(1) page πŸ’… this one lives in the Cooperative Computing Tools manual, and it's literally the little engine that could for sequence filtering 🧚


🌸 NAME 🌸

sand_filter_kernel β€” filter read sequences sequentially πŸ’–


πŸŽ€ SYNOPSIS πŸŽ€

sand_filter_kernel [options] <sequence file> [second sequence file]

πŸ¦‹ DESCRIPTION πŸ¦‹

so sand_filter_kernel filters a list of genomic sequences and spits out a list of candidate pairs, which then go off to get a way more detailed alignment 😌

ngl, you're not normally the one calling this one directly. It gets invoked by sand_filter_master(1) for each sequential step of a distributed alignment workload. It's giving backstage crew, not main character. But it ate, fr fr.

Here's the tea on how it reads your files πŸ‘‡

  • If you give it one sequence file, sand_filter_kernel will look for similarities between all the sequences in that file.
  • If you give it two files, it will look for similarities between sequences in the first file and the second file.

And the output? A list of candidate pairs πŸ’– listing the name of the candidate sequences and a starting position for alignment. iconic behavior honestly.


✨ OPTIONS ✨

  • -s <size> β€” Size of "rectangle" for filtering. You can determine the size dynamically by passing in d rather than a number. no cap, that d is doing a lot of heavy lifting 🫢
  • -r <file> β€” A meryl file of repeat mers to be ignored. bye bye repeats πŸ’€
  • -k <size> β€” The k-mer size to use in candidate selection (default is 22).
  • -w <number> β€” The minimizer window size to use in candidate selection (default is 22).
  • -o <filename> β€” The output file. Default is stdout. (so if you don't say anything, it just yells into your terminal, love that for it 🌈)
  • -d <subsystem> β€” Enable debug messages for this subsystem. Try -d all to start. πŸ‘€
  • -v β€” Show version string.
  • -h β€” Show help screen.

πŸ’€ EXIT STATUS πŸ’€

  • On success, returns zero ✨
  • On failure, returns non-zero 😭

🌈 EXAMPLES 🌈

okay so real talk: users do not normally invoke sand_filter_kernel directly. Instead, options such as the k-mer size, minimizer window, and repeat file may be specified by the same arguments to sand_filter_master(1) instead. it's giving "don't talk to the kernel, talk to the master" 😌

For example, to run a filter with a k-mer size of 20, window size of 24, and repeat file of mydata.repeats:

% sand_filter_master -k 20 -w 24 -r mydata.repeats mydata.cfa mydata.cand

periodt. πŸ’…


The Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame. This software is distributed under the GNU General Public License. See the file COPYING for details.


🫢 SEE ALSO 🫢


and that's the whole vibe check bestie 🧚 this page was brought to you by CCTools 8.0.0 DEVELOPMENT, serving the Cooperative Computing Tools manual, and yes it's still out here being sand_filter_kernel(1) at the bottom of every page like the little signature it is πŸ’– go read sand_filter_master(1) next, iykyk 🌸

πŸ“¦ where this page comes from