Skip to content

Running ImReP

Serghei Mangul edited this page May 23, 2017 · 13 revisions

ImReP help message

In order to see ImReP help message, invoke

$ python imrep.py -h

from the command line.

##Necessary parameters

  • reads_file - file with RNA-Seq or TCR-(BCR-)-Seq reads in .fastq or .fasta format. If the reads are paired, then you must ensure that they are stored in one file.

  • output_clones - output file.

##Optional parameters

  • --fastq, a binary flag used to indicate that the input file with unmapped reads is in fastq format

  • -s SPECIES, --species SPECIES - species (human or mouse, default human).

  • -o OVERLAPLEN, --overlapLen OVERLAPLEN - the minimal length to consider between reads overlapping with a V gene and reads overlapping with a J gene. Default value is 10 amino acids.

  • --noOverlapStep - a binary flag used in case if the user does not want to run the second stage of the ImReP assembly.

  • -t CASTTHRESHOLD - the -t option has been added to control the stringency of CDR3 clustering. The value can be from 0.0 to 1.0. Note that thresholds near 1.0 are more liberal and result in more CDR3 to be reported. The default value is 0.2

  • -c CHAINS, --chains CHAINS - comma separated value of chains to search for. The default value is IGH,IGK,IGL,TRA,TRB,TRD,TRG.

  • -extendedOutput - if this option is set, ImReP will produce two additional files: full_cdr3.txt and partial_cdr3.txt containing detailed information for each read (V(D)J recombination and CDR3 it comes from)

Clone this wiki locally