FusionSeq List of programs

From GersteinInfo

(Difference between revisions)
Jump to: navigation, search
(geneFusions)
(geneFusions)
Line 59: Line 59:
<center>[[#top|Top]]</center>
<center>[[#top|Top]]</center>
 +
=== Mis-alignment filters ===
 +
==== gfrLargeScaleHomologyFilter ==== 
 +
 +
gfrLargeScaleHomologyFilter removes potential fusion transcript candidates if the two genes are paralogs. It uses [http://www.treefam.org/ TreeFam] to establish is two genes have similar sequences.
 +
 +
'''Usage''':
 +
 +
gfrLargeScaleHomologyFilter
 +
 +
* Inputs: [[#Gene_Fusion_Report_(GFR)|GFR]] from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** none
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
 +
 +
==== gfr ==== 
 +
 +
geneFusions identifies potential fusion transcript candidates from an alignment file.
 +
 +
'''Usage''':
 +
 +
geneFusions prefix minNumberOfReads
 +
 +
* Inputs: from STDIN
 +
* Outputs: Reports [[#Gene_Fusion_Report_(GFR)|GFR]] to STDOUT
 +
* ''Required arguments''
 +
** prefix -  the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
 +
** minNumberOfReads - the minimum number of reads required to include a candiate
 +
* ''Optional arguments''
 +
** none
 +
 +
<br>
 +
 +
<center>[[#top|Top]]</center>
... to be continued
... to be continued

Revision as of 19:26, 19 August 2010

FusionSeq main web page
User documentation main

Contents

Data formats

FusionSeq use a few data formats to perform its operations.

Mapped Read Format (MRF)

This format is defined in the context of RSEQtools. More details can be found here.

Gene Fusion Report (GFR)

This file format defines the relevant information for each fusion transcript candidate. The rationale is that different filters can be applied to exclude “false positives” artificial fusions starting from an initial set. We also provide a parser that interprets this format allowing the user to propagate easily any changes to this format. For a given fusion candidate, involving gene A and gene B, the basic GFR format requires the following fields:

  1. ID: the ID of the fusion candidate: typically it contains the sample name and a unique number separated by an underscore. The number is padded with zeros for consistency;
  2. SPER, DASPER and RESPER: scoring of the fusion candidate;
  3. Number of inter-transcript reads, i.e. the number of pairs having the ends mapped to the two genes;
  4. P-value of the insert size distribution analysis for the fusion transcript. Since we do not know the actual composition of the fusion transcript, we computed the p-value for both directions: AB (where gene A is upstream of gene B) and BA (where gene B is upstream of gene A);
  5. Number of intra-transcript reads for gene A and gene B, respectively, i.e the number of pairs where both ends map to the same gene;
  6. The type of the fusion: cis, when both genes are on the same chromosome, or trans, otherwise;
  7. Name(s) of the transcripts: all the UCSC gene IDs of the isoforms of each gene in the annotation separated by the pipe symbol '|';
  8. Chromosome of the genes;
  9. Strand information;
  10. Start and end coordinates of the longest transcript for both genes;
  11. Number of exons in the composite model for both genes;
  12. Coordinates of the exons in the composite model: each exon is separated by the pipe symbol '|' and start and end coordinates are comma-separated;
  13. Exon-pair count: it describes which exons are connected and the number of inter-reads;
  14. Inter-reads: the exon and the coordinates of the reads that join the two genes. Exon number, start and end coordinates are reported as comma-separated, with the pipe symbol '|' separating the different pairs;
  15. Reads of the transcripts: the actual sequence of all the inter-reads.

The GFR format can include additional optional information computed in the subsequent processing. For example, it is possible to add gene symbols and descriptions from the UCSC knownGene annotation set.

Top

Breakpoint data format (BP)

Similarly to GFR, the junction-sequence identifier uses a standard format to capture the results of this analysis. For each tile that has at least 1 read aligned to, it reports, comma-separated:

  1. chromosome, start and end coordinates of the first tile, using UCSC notation: “chr:start-end”, although the intervals are 1-based and closed;
  2. chromosome, start and end coordinates of the second tile
  3. All the sequences of the reads mapped to that tile with the offset information, separated by the pipe symbol.

For example, one line may read as:

chr21:38764851-38764892,chr21:41758661-41758702,31:GTAGAATCATTCATTTCATTCTTGCAAACCAGCCTGCTTGGCCAGGAGGCA|30:TGTAGAATCATTCATTTCATTCTTGCAAACCAGCCTGCTTGGCCAGGAGGC

where two reads support this specific junction.

Top

Programs

geneFusions

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: Takes an MRF file from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

Mis-alignment filters

gfrLargeScaleHomologyFilter

gfrLargeScaleHomologyFilter removes potential fusion transcript candidates if the two genes are paralogs. It uses TreeFam to establish is two genes have similar sequences.

Usage:

gfrLargeScaleHomologyFilter
  • Inputs: GFR from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • none
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

gfr

geneFusions identifies potential fusion transcript candidates from an alignment file.

Usage:

geneFusions prefix minNumberOfReads 
  • Inputs: from STDIN
  • Outputs: Reports GFR to STDOUT
  • Required arguments
    • prefix - the main ID of each candidate, i.e. prefix_0001, prefix_0002, etc.
    • minNumberOfReads - the minimum number of reads required to include a candiate
  • Optional arguments
    • none


Top

... to be continued

Personal tools