FILTLONG(1)

πŸ’– FILTLONG(1) πŸ’–

okay so bestie, listen β€” filtlong is a quality filtering tool for Nanopore and PacBio reads and it is genuinely the moment. long reads? filtered. mid reads? gone. we're keeping only the good ones. periodt. πŸ’…


✨ NAME ✨

filtlong β€” quality filtering tool for Nanopore and PacBio reads πŸ¦‹


🌸 SYNOPSIS 🌸

filtlong {OPTIONS} [input_reads]

that's it. that's the whole vibe. options go in, reads come out, everyone's thriving. ✨


πŸ‘‘ OPTIONS πŸ‘‘

πŸŽ€ positional arguments:

  • input_reads β€” the long reads you want filtered, bestie. hand them over. 🫢

πŸ’… optional arguments:

⭐ output thresholds:

  • -t[int], --target_bases [int] β€” keep only the best reads, up until you've hit this many total bases. that's the cap, no cap. πŸ”₯
  • -p[float], --keep_percent [float] β€” keep only this percentage of the best reads (measured by bases, so it's a base girlie not a count girlie). πŸ’–
  • --min_length [int] β€” the minimum length threshold, fr fr. anything shorter? not invited. πŸ™ˆ
  • --min_mean_q [float] β€” minimum mean quality threshold. πŸŽ€
  • --min_window_q [float] β€” minimum window quality threshold. 🌸

🌈 external references (if provided, read quality will be determined using these instead of from the Phred scores):

like, if you hand it a reference, it's gonna judge your reads against that instead of the Phred scores. iykyk. πŸ‘‘

  • -a[file], --assembly [file] β€” reference assembly in FASTA format. 🧚
  • -1[file], --illumina_1 [file] β€” reference Illumina reads in FASTQ format. πŸ’œ
  • -2[file], --illumina_2 [file] β€” reference Illumina reads in FASTQ format. πŸ’œ

πŸ¦‹ score weights (control the relative contribution of each score to the final read score):

these three lil weights decide how much each score pulls up to the final read score. balance them like your life depends on it (it doesn't, but still). ✨

  • --length_weight [float] β€” weight given to the length score (default: 1). πŸ“
  • --mean_q_weight [float] β€” weight given to the mean quality score (default: 1). πŸ’―
  • --window_q_weight [float] β€” weight given to the window quality score (default: 1). πŸͺŸ

πŸ’€ read manipulation:

  • --trim β€” trim non-k-mer-matching bases from the start/end of reads. literally trimming the edges off. slay. βœ‚οΈ
  • --split [split] β€” split reads at this many (or more) consecutive non-k-mer-matching bases. cutting the read into pieces, main character energy. πŸ”ͺ

🌟 other:

  • --window_size [int] β€” size of the sliding window used when measuring window quality (default: 250). πŸͺŸβœ¨
  • --verbose β€” verbose output to stderr with info for each read. not me being nosy about every single read. 😭
  • --version β€” display the program version and quit. πŸ’…
  • -h, --help β€” display this help menu. the classic. πŸŽ€
for more information, go to: https://github.com/rrwick/Filtlong β€” go go go, bestie. 🫢

πŸ’œ AUTHOR πŸ’œ

This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program. iconic of them honestly. πŸ‘‘


and that's the whole thing!! this is filtlong version 0.2.0, dated January 2019 β€” shoutout to the Debian fam for shipping it, we're obsessed. πŸ’–βœ¨πŸŽ€ bye bestie, go filter some reads πŸ¦‹πŸŒΈ