SEGEMEHL(1)

πŸ’– SEGEMEHL(1) πŸ’–

okay bestie, welcome to the segemehl manual page, living in the User Commands section, and honestly? she's a whole legend. let's get into it 🧚✨


🌸 NAME 🌸

segemehl β€” Heuristic mapping of short sequences. that's it, that's the vibe. no cap. πŸ’…


✨ SYNOPSIS ✨

like, here's how you actually call her:

segemehl [-besVOc] -d <file> [<file>] [-q <file>] [-p <file>] [-i
<file>] [-j <file>] [-x <file>] [-y <file>] [-G <file>] [-g <string>]
[-t <n>] [-o <string>] [-u <file>] [-B <string>] [-F <n>] [-S
[<basename>]] [-A <n>] [-D <n>] [-E <double>] [-H] [-m <n>] [-Z <n>] [-W
<n>] [-U <n>] [-l <f>] [-w <double>] [-X <n>] [-J <n>] [-I <n>] [-M <n>]
[-n <n>] [-r <n>] [--skipidcheck] [--showalign] [--nohead]

look at all those flags, she's booked and busy πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

so. Segemehl is a software to map short sequencer reads to reference genomes. she implements a matching strategy based on enhanced suffix arrays (ESA). she accepts fasta and fastq queries (gzip’ed and bgzip'ed, because she's inclusive like that πŸ’…). and like β€” not only does she align reads from standard DNA- and RNA-seq protocols, she ALSO lets you map bisulfite converted reads (Lister and Cokus) and she implements a split read mapping strategy. multi-talented queen, honestly. πŸ‘‘

her output is a SAM or BAM formatted alignment file. and in the case of split-read mapping, extra BED files get written to the disc β€” those BED files may be summarized with the postprocessing tool haarz. and for bisulfite converted reads? raw methylation rates may also be called with haarz. she works with haarz, iconic duo, iykyk. 🫢

in brief bestie β€” here's the tea β˜•

so, for each suffix of a read, segemehl aims to find the best-scoring seed. seeds might contain insertions, deletions, and mismatches (differences). the number of differences allowed within a single seed is user-controlled and is crucial for the runtime of the program β€” like, actually important, don't skip this. subsequently, seeds that undercut the user-defined E-value are passed on to an exact semi-global alignment procedure. and finally, reads with a minimum accuracy of percent are reported to the user. periodt. πŸ’–


πŸ‘‘ OPTIONS πŸ‘‘

πŸ“ INPUT πŸ“

  • -d, --database <file> [<file>] β€” list of path/filename(s) of fasta database sequence(s). yes, plural, you can hand her a whole list πŸ’…
  • -q, --query <file> β€” path/filename of query sequences (default:none)
  • -p, --mate <file> β€” path/filename of mate pair sequences (default:none)
  • -i, --index <file> β€” path/filename of db index (default:none)
  • -j, --index2 <file> β€” path/filename of second db index (default:none)
  • -x, --generate <file> β€” generate db index and store to disk (default:none)
  • -y, --generate2 <file> β€” generate second db index and store to disk (default:none)
  • -G, --readgroupfile <file> β€” filename to read @RG header (default:none)
  • -g, --readgroupid <string> β€” read group id (default:none)
  • -t, --threads <n> β€” start <n> threads (default:1). give her more threads, she'll go faster, she deserves it πŸƒβ€β™€οΈπŸ’¨

🌈 OUTPUT 🌈

  • -o, --outfile <string> β€” outputfile (default:none)
  • -b, --bamabafixoida β€” generate a bam output (-o <filename> required). yes that's the actual flag name, we don't question it, we just respect it πŸ™ˆ
  • -u, --nomatchfilename <file> β€” filename for unmatched reads (default:none)
  • -e, --briefcigar β€” brief cigar string (M vs X and =)
  • -s, --progressbar β€” show a progress bar. honestly the most soothing option on this whole page, watching her work πŸ˜­πŸ’–
  • -B, --filebins <string> β€” file bins with basename <string> for easier data handling (default:none)
  • -V, --MEOP β€” output MEOP field for easier variance calling in SAM (XE:Z:)

🌸 ALIGNMENT 🌸

  • -F, --bisulfite <n> β€” bisulfite aln with methylC-seq/Lister et al. (=1) or bs-seq/Cokus et al. protocol (=2) (default:0)
  • -S, --splits [<basename>] β€” detect split/spliced reads. (default:none)
  • -A, --accuracy <n> β€” min percentage of matches per read in semi-global alignment (default:90)
  • -D, --differences <n> β€” search seeds initially with <n> differences (default:1)
  • -E, --evalue <double> β€” max evalue (default:5.000000)
  • -H, --hitstrategy β€” report only best scoring hits (=1) or all (=0) (default:1)
  • -m, --minsize <n> β€” minimum length of queries (default:12)
  • -Z, --minfraglen <n> β€” min length of a spliced fragment (default:20)
  • -W, --minsplicecover <n> β€” min coverage for spliced transcripts (default:80)
  • -U, --minfragscore <n> β€” min score of a spliced fragment (default:18)
  • -l, --splicescorescale <f> β€” report spliced alignment with score s only if <f>*s is larger than next best spliced alignment (default:0.900000)
  • -w, --maxsplitevalue <double> β€” max evalue for splits (default:50.000000)

πŸ’œ SPECIAL πŸ’œ

  • -X, --dropoff <n> β€” dropoff parameter for extension (default:8)
  • -J, --jump <n> β€” search seeds with jump size <n> (0=automatic) (default:0)
  • -O, --order β€” sorts the output by chromsome and position (might take a while!). bestie she warned you, don't be surprised when it takes a while 😭
  • -I, --maxpairinsertsize <n> β€” maximum size of the inserts (paired end) in case of multiple hits (default:200000)
  • -M, --maxinterval <n> β€” maximum width of a suffix array interval, i.e. a query seed will be omitted if it matches more than <n> times (default:100)
  • -c, --checkidx β€” check index
  • -n, --extensionpenalty <n> β€” penalty for a mismatch during extension (default:4)
  • -r, --maxout <n> β€” maximum number of alignments that will be reported. If set to zero, all alignments will be reported (default:0)
  • --skipidcheck β€” do not check whether the fastq ids of mates / paired ends match. Instead, the first mate (-q) will be used for output only.
  • --showalign β€” show alignments
  • --nohead β€” do not output header

πŸ’€ BUGS πŸ’€

found a bug? not her fault, but also please tell her πŸ₯Ί β€” Please report bugs to steve@bioinf.uni-leipzig.de


πŸŽ€ SEE ALSO πŸŽ€

go look, she has a whole website, main character energy fr fr ✨


πŸ“š REFERENCES πŸ“š

  • 2008 Bioinformatik Leipzig
  • 2018 Leibniz Institute on Aging (FLI)

🫢 AUTHOR 🫢

This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program. thank you Andreas, you ate πŸ’…βœ¨


okay that's the whole page bestie, you're officially segemehl-literate, go map some reads πŸŒΈπŸ¦‹πŸ’–

segemehl 0.3 β€” October 2018 β€” SEGEMEHL(1) πŸ’œ mwah, go slay πŸ‘‘