LiftUp format: Difference between revisions

From genomewiki
Jump to navigationJump to search
No edit summary
No edit summary
 
Line 20: Line 20:
    
    
   chr1    2101    2201    voila
   chr1    2101    2201    voila
==Command Syntax==
<PRE>
liftUp - change coordinates of .psl, .agp, .gap, .gl, .out, .gff, .gtf .bscore
.tab .gdup .axt .chain .net, genePred, .wab, .bed, or .bed8 files to parent
coordinate system.
usage:
  liftUp [-type=.xxx] destFile liftSpec how sourceFile(s)
The optional -type parameter tells what type of files to lift
If omitted the type is inferred from the suffix of destFile
Type is one of the suffixes described above.
DestFile will contain the merged and lifted source files,
with the coordinates translated as per liftSpec.  LiftSpec
is tab-delimited with each line of the form:
  offset oldName oldSize newName newSize
LiftSpec may optionally have a sixth column specifying + or - strand,
but strand is not supported for all input types.
The 'how' parameter controls what the program will do with
items which are not in the liftSpec.  It must be one of:
  carry - Items not in liftSpec are carried to dest without translation
  drop  - Items not in liftSpec are silently dropped from dest
  warn  - Items not in liftSpec are dropped.  A warning is issued
  error - Items not in liftSpec generate an error
If the destination is a .agp file then a 'large inserts' file
also needs to be included in the command line:
  liftUp dest.agp liftSpec how inserts sourceFile(s)
This file describes where large inserts due to heterochromitin
should be added. Use /dev/null and set -gapsize if there's not inserts file.
options:
  -nohead  No header written for .psl files
  -dots=N Output a dot every N lines processed
  -pslQ  Lift query (rather than target) side of psl
  -axtQ  Lift query (rather than target) side of axt
  -chainQ  Lift query (rather than target) side of chain
  -netQ  Lift query (rather than target) side of net
  -wabaQ  Lift query (rather than target) side of waba alignment
        (waba lifts only work with query side at this time)
  -nosort Don't sort bed, gff, or gdup files, to save memory
  -gapsize change contig gapsize from default
  -ignoreVersions - Ignore NCBI-style version number in sequence ids of input files
  -extGenePred lift extended genePred
</PRE>
[[Category:Technical FAQ]]

Latest revision as of 16:56, 9 May 2008

LiftUp can convert coordinates in most annotation files. It can add to positions and change the chromosome part of those files. It's main input is the lift-file that specifies how to convert the coordinates.

The format is:

offset oldName oldSize newName newSize

An example:

 0       frag1   1000    chr1    2000
 1001    frag2   1000    chr1    1000

Typing this command:

 liftUp stdout -type=.bed test.lft warn test.bed

will lift the following feature

 frag2   1100    1200    voila

to the following one:

 chr1    2101    2201    voila

Command Syntax

liftUp - change coordinates of .psl, .agp, .gap, .gl, .out, .gff, .gtf .bscore 
.tab .gdup .axt .chain .net, genePred, .wab, .bed, or .bed8 files to parent
coordinate system.

usage:
   liftUp [-type=.xxx] destFile liftSpec how sourceFile(s)
The optional -type parameter tells what type of files to lift
If omitted the type is inferred from the suffix of destFile
Type is one of the suffixes described above.
DestFile will contain the merged and lifted source files,
with the coordinates translated as per liftSpec.  LiftSpec
is tab-delimited with each line of the form:
   offset oldName oldSize newName newSize
LiftSpec may optionally have a sixth column specifying + or - strand,
but strand is not supported for all input types.
The 'how' parameter controls what the program will do with
items which are not in the liftSpec.  It must be one of:
   carry - Items not in liftSpec are carried to dest without translation
   drop  - Items not in liftSpec are silently dropped from dest
   warn  - Items not in liftSpec are dropped.  A warning is issued
   error - Items not in liftSpec generate an error
If the destination is a .agp file then a 'large inserts' file
also needs to be included in the command line:
   liftUp dest.agp liftSpec how inserts sourceFile(s)
This file describes where large inserts due to heterochromitin
should be added. Use /dev/null and set -gapsize if there's not inserts file.

options:
   -nohead  No header written for .psl files
   -dots=N Output a dot every N lines processed
   -pslQ  Lift query (rather than target) side of psl
   -axtQ  Lift query (rather than target) side of axt
   -chainQ  Lift query (rather than target) side of chain
   -netQ  Lift query (rather than target) side of net
   -wabaQ  Lift query (rather than target) side of waba alignment
        (waba lifts only work with query side at this time)
   -nosort Don't sort bed, gff, or gdup files, to save memory
   -gapsize change contig gapsize from default
   -ignoreVersions - Ignore NCBI-style version number in sequence ids of input files
   -extGenePred lift extended genePred