NANOFILT(1)

πŸ’– NanoFilt πŸ’–

Okay bestie, this is the manual page for NanoFilt, filed under User Commands in section 1 πŸŽ€ Let's get into it.


✨ NAME ✨

NanoFilt is the tool for filtering and trimming long read sequencing data πŸ§¬πŸ’…


🌸 DESCRIPTION 🌸

Here's the usage line you'll see when you run it, so you know what the shape of the command looks like πŸ‘€

usage: NanoFilt [-h] [-v] [--logfile LOGFILE] [-l LENGTH]

       [--maxlength MAXLENGTH] [-q QUALITY] [--minGC MINGC] [--maxGC
       MAXGC] [--headcrop HEADCROP] [--tailcrop TAILCROP] [-s SUMMARY]
       [--readtype {1D,2D,1D2}] [input]

NanoFilt can do quality, length, and/or GC filtering on (long read) fastq data, and it's giving main character energy because it reads from stdin πŸ¦‹


πŸŽ€ General options: πŸŽ€

  • -h, --help β€” shows you the help and then exits πŸ™ˆ
  • -v, --version β€” prints the version and exits ✨
  • --logfile LOGFILE β€” lets you pick the path and filename for the log file πŸ“
  • input β€” the input, which is an uncompressed fastq file πŸ“

πŸ’œ Options for filtering reads on.: πŸ’œ

  • -l LENGTH, --length LENGTH β€” filters on a minimum read length πŸ“
  • --maxlength MAXLENGTH β€” filters on a maximum read length πŸ“
  • -q QUALITY, --quality QUALITY β€” filters on a minimum average read quality score πŸ‘‘
  • --minGC MINGC β€” the sequences need GC content that's >= this number. It's a float between 0.0 and 1.0. Heads up, this one gets ignored if you're using a summary file πŸ™ˆ
  • --maxGC MAXGC β€” the sequences need GC content that's <= this number. It's a float between 0.0 and 1.0. Same deal, it gets ignored if you're using a summary file πŸ™ˆ

πŸ¦‹ Options for trimming reads.: πŸ¦‹

  • --headcrop HEADCROP β€” trims n nucleotides off the start of the read βœ‚οΈ
  • --tailcrop TAILCROP β€” trims n nucleotides off the end of the read βœ‚οΈ

🧚 Input options.: 🧚

  • -s SUMMARY, --summary SUMMARY β€” uses an albacore or guppy summary file to get the quality scores πŸ“
  • --readtype {1D,2D,1D2} β€” picks which read type to pull info about from the summary. Your choices are 1D, 2D, or 1D2 🌈

πŸ’… EXAMPLES: πŸ’…

Here are some looks you can copy. Slay πŸ”₯

gunzip -c reads.fastq.gz | NanoFilt -q 10 -l 500 --headcrop 50 | minimap2 genome.fa - | samtools sort -O BAM -@24 -o alignment.bam -
gunzip -c reads.fastq.gz | NanoFilt -q 12 --headcrop 75 | gzip > trimmed-reads.fastq.gz
gunzip -c reads.fastq.gz | NanoFilt -q 10 | gzip > highQuality-reads.fastq.gz

🫢 SEE ALSO 🫢

The full documentation for NanoFilt is maintained as a Texinfo manual. If the info and NanoFilt programs are properly installed at your site, the command below should give you access to the complete manual πŸ“š
info NanoFilt

Bestie, that's the whole page πŸ’– NanoFilt 2.6.0 from June 2020, filed under NANOFILT(1). Stay iconic πŸŒˆπŸ’…βœ¨