INSEGT(1)

πŸ“¦
version 2.5.2 Β· 2 versions
, in ubuntu stonking

✨ INSEGT(1) ✨

okay so bestie, this is the insegt manual page β€” short for INtersecting SEcond Generation sequencing daTa with annotation πŸ§¬πŸ’–. She's a little command-line queen and honestly? iconic. Let's get into it.


🌸 NAME 🌸

insegt β€” INtersecting SEcond Generation sequencing daTa with annotation


πŸ¦‹ SYNOPSIS πŸ¦‹

insegt [OPTIONS] <ALIGMENTS-FILE> <ANNOTATIONS-FILE>

(yes the flag spellings are exactly like that, no cap, we do not fix what we did not break πŸ’…)


πŸ‘‘ DESCRIPTION πŸ‘‘

Okay so INSEGT is a tool for analyzing alignments of RNA-Seq reads β€” single-end or paired-end, she does both, versatile πŸ’… β€” by using gene-annotations.

The input to INSEGT is a SAM file containing the alignments, plus a file containing the annotations of the reference genome, either in GFF or GTF format. Two files in, science out. periodt. ✨


πŸŽ€ REQUIRED ARGUMENTS πŸŽ€

  • ARGUMENT 0 INPUT_FILE β€” valid filetype is: .sam. πŸ“„
  • ARGUMENT 1 INPUT_FILE β€” valid filetypes are: .gtf and .gff. πŸ“‘βœ¨
fr fr these two are not optional. she needs them. feed her or she will simply not run πŸ’€

πŸ’– OPTIONS πŸ’–

  • -h, --help β€” displays the help message. when in doubt, ask her nicely 🫢
  • --version β€” displays version information. she'll tell you who she is πŸ’β€β™€οΈ

✨ Options: : ✨

(that heading is genuinely what it says, i'm not even joking, leaving it exactly as-is 😭)

  • -ro, --read-output OUTPUT_FILE β€” output filename for read-output, which contains the mapped annotations followed by their parent annotation. Valid filetype is: .gff. 🌈
  • -ao, --anno-output OUTPUT_FILE β€” output filename for anno-output, which contains the annotations similar to the GFF input, plus the counts of the mapped reads and the normalized expression levels in RPKM. Valid filetype is: .gff. πŸ“Š
  • -to, --tuple-output OUTPUT_FILE β€” output filename for tuple-output, which contains exon tuples connected by reads or matepairs. Valid filetype is: .gff. πŸ”—
  • -fo, --fusion-output STRING β€” output filename for fusion-output, which contains exon tuple of gene fusions. This one is an Advanced option, and currently there's no output port for KNIME. One of gff. πŸ§ͺ
  • -n, --ntuple INTEGER β€” ntuple. Default: 2. πŸ”’
  • -o, --offset-interval INTEGER β€” offset to short alignment-intervals for search. Default: 5. πŸ“
  • -t, --threshold-gaps INTEGER β€” threshold for allowed gaps in alignment (not introns). Default: 5. 🚧
  • -c, --threshold-count INTEGER β€” threshold for min. count of tuple for output. Default: 1. πŸ”’
  • -r, --threshold-rpkm DOUBLE β€” threshold for min. RPKM of tuple for output. Default: 0.0. πŸ“ˆ
  • -m, --max-tuple β€” create only maxTuple (which are spanned by the whole read). πŸ†
  • -e, --exact-ntuple β€” create only Tuple of exact length n. By default all tuple up to the given length are computed β€” but heads up: if -m is set, -e will be ignored. ⚠️
  • -u, --unknown-orientation β€” orientation of reads is unknown. πŸ€·β€β™€οΈ

🌟 EXAMPLES 🌟

okay here are the little demo runs, all living in the example/ folder πŸ“

  1. Run INSEGT on example files with default parameters:
insegt  example/alignments.sam example/annotations.gff
  1. Run INSEGT on example files and only compute maxTuple:
insegt -m example/alignments.sam example/annotations.gff
  1. Run INSEGT on example files and only output tuple with a min. count of 2:
insegt -c 2 example/alignments.sam example/annotations.gff

πŸ’œ and that's the whole page bestie. go align something. iykyk.

that's a wrap on the insegt manual β€” this is insegt 1.1.14, shipped as a [tarball], and i'd like to thank her for her service πŸ«‘πŸ’– stay hydrated, read your SAM files, and may your tuples always be connected. bye bestie!! βœ¨πŸŽ€πŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from