LIGHTER(1)

✨ lighter(1) β€” the sequencing error corrector that actually respects your RAM ✨

okay bestie, gather round πŸ’– this is the manual page for lighter, a User Command that fixes sequencing errors and does it fast and cheap on memory. she's that girl. no cap.


🌸 NAME 🌸

lighter β€” fast and memory-efficient sequencing error corrector

like literally, that's the whole vibe: correcting sequencing errors without making your computer cry. 🫢


πŸŽ€ SYNOPSIS πŸŽ€

lighter [OPTIONS]

that's it. that's the whole thing. you feed her options, she eats them. periodt. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the tea β˜• Lighter is a fast, memory-efficient tool for correcting sequencing errors. and the way she does it is genuinely iconic:

Lighter avoids counting k-mers. instead?? she uses a pair of Bloom filters β€” one holding a sample of the input k-mers, and the other holding k-mers likely to be correct. yes, two. a whole duo. main character energy fr fr. ✨

and the trick?? as long as the sampling fraction is adjusted in inverse proportion to the depth of sequencing, the Bloom filter size can be held constant while maintaining near-constant accuracy. like, she doesn't balloon up when your data gets deep. she stays chill. πŸ’…

Lighter is parallelized, uses no secondary storage, and is both faster and more memory-efficient than competing approaches while achieving comparable accuracy. not me being obsessed with an error corrector 😭


✨ OPTIONS: ✨

πŸ’– Required parameters:

these ones? not optional. she needs them. don't skip them bestie.

  • -r seq_file β€” seq_file is the path to the sequence file. you can use multiple -r to specify multiple sequence files 🫢

the file can be fasta and fastq, and can be gzip'ed with extension *.gz. and when the input file is *.gz, the corresponding output file will also be gzip'ed. matching energy. iconic.

  • -k kmer_length genome_size alpha β€” (see README for information on setting alpha) πŸ“–

or

  • -K kmer_length genom_size β€” in this case, the genome size should be relative accurate. like, actually accurate. don't be sloppy with this one. πŸ™ˆ

🌈 Other parameters:

  • -od output_file_directory β€” (default: ./) πŸ“
  • -t num_of_threads β€” number of threads to use (default: 1) 🧡 go wild, she's parallelized
  • -maxcor INT β€” the maximum number of corrections within a 20bp window (default: 4)
  • -trim β€” allow trimming (default: false) βœ‚οΈ
  • -discard β€” discard unfixable reads. Will LOSE paired-end matching when discarding (default: false) πŸ’€
bestie. read that again. you will LOSE your paired-end matching. she said what she said. be careful.
  • -noQual β€” ignore the quality socre (default: false) πŸ™ˆ yes, "socre". we keep it exactly as written. character for character. that's the rule. πŸ’…
  • -newQual ascii_quality_score β€” set the quality for the bases corrected to the specified score (default: not used) ⭐
  • -saveTrustedKmers file β€” save the trusted kmers to specified file then stop (default: not used) πŸ›‘
  • -loadTrustedKmers file β€” directly get solid kmers from specified file (default: not used) πŸ“₯
  • -zlib compress_level β€” set the compression level(0-9) of gzip (default: 1) πŸ—œοΈ
  • -h β€” print the help message and quit πŸ†˜
  • -v β€” print the version information and quit πŸ‘‘

πŸ’œ AUTHOR πŸ’œ

This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program.

shoutout to Andreas, the realest 🫢


and that's the whole page bestie!! you're now fully literate in lighter(1). go correct some errors, slay, and remember: sampling fraction in inverse proportion to sequencing depth. iykyk πŸ’…βœ¨

lighter version 1.1.2, from May 2020. mwah, love u, bye πŸŽ€πŸ¦‹πŸ’–