Difference between revisions of "SHORE Subprograms"

From SHORE wiki
Jump to: navigation, search
(→‎shore compress)
(→‎shore 2dex)
Line 1: Line 1:
−
=shore 2dex=
 
−
 
−
Range-indexing and query for tab-delimited text files
 
−
 
−
 
−
'''Usage:''' shore 2dex [OPTIONS] [TEXT_FILES]
 
−
 
−
{|
 
−
| colspan=2 | '''Mandatory'''
 
−
|----
 
−
| ''-i'', ''--infiles=<arg[,...]>''  ||                        || A comma-separated list of tab-delimited plain-text input files (can also be any [[RunFolder|SHORE directory]] when ''-f MAPLIST'' is set)
 
−
|----
 
−
|----
 
−
| colspan=2 | '''Format Options'''
 
−
|----
 
−
| ''-f'', ''--format=<arg>''        ||                        || Provide file type for automatic settings, valid file types: MAPLIST, GFF, SAM
 
−
|----
 
−
| ''-c'', ''--chr-column=<arg>''    ||                        || Column w. chromosome or sequence name, provide the column name or @<column_number>
 
−
|----
 
−
| ''-p'', ''--pos-column=<arg>''    ||                        || Column w. start position, provide the column name or @<column_number>
 
−
|----
 
−
| ''-s'', ''--size-column=<arg>''    ||                        || Column w. feature size, provide the column name or @<column_number>
 
−
|----
 
−
| ''-e'', ''--end-column=<arg>''    ||                        || Column w. end position (inclusive), provide the column name or @<column_number>
 
−
|----
 
−
| ''-x'', ''--xend-column=<arg>''    ||                        || Column w. end position (exclusive), provide the column name or @<column_number>
 
−
|----
 
−
| ''-C'', ''--commentchar=<arg>''    ||                        || Comment line symbol
 
−
|----
 
−
|----
 
−
| colspan=2 | '''Index Options'''
 
−
|----
 
−
| ''-B'', ''--blocksize=<arg>''      || (Default: ''131072'')  || Block size determining the index resolution in bytes
 
−
|----
 
−
| ''-G'', ''--maxgap=<arg>''        || (Default: ''131072'')  || Maximum sequence gap in a block
 
−
|----
 
−
|----
 
−
| colspan=2 | '''Query Options'''
 
−
|----
 
−
| ''-q'', ''--query=<arg>''          ||                        || A range to query; prints all overlapping records. Valid ranges: 'SEQ:POS~SIZE', 'SEQ:POS..END', 'SEQ1:POS..SEQ2:END', 'SEQ:POS...XEND', 'SEQ1:POS...SEQ2:XEND' (END: inclusive, XEND: exclusive)
 
−
|----
 
−
|----
 
−
| colspan=2 | '''Other'''
 
−
|----
 
−
| ''-v'', ''--verbose''              ||                        || Be more verbose
 
−
|----
 
−
| ''-Q'', ''--quiet''                ||                        || Be less verbose
 
−
|----
 
−
|}
 
−
 
 
=shore idtrans=
 
=shore idtrans=
  

Revision as of 14:47, 23 September 2011

shore idtrans

SHORE uses numerical identifiers for all sequences of the reference. shore idtrans simplifies translating these numbers in some of the result files back into chromosome names as specified in the reference fasta file (and vice versa).

Required is either a *.trans file which is stored in the IndexFolder by shore preprocess, or a ref.txt file generated by shore mapflowcell.


Usage: shore idtrans [OPTIONS] FILES

Allowed options
-t, --transfile=<arg> *.trans file from IndexFolder
-r, --reffile=<arg> ref.txt file generated by mapflowcell
-o, --outfile=<arg> Output file (default: <infile>.idtrans)
-c, --columns=<arg[,...]> (Default: chr) Columns to be translated (column names or @<column_number>)
--name2id Translate names to IDs (default: translate IDs to names)
--nocompress Do not compress output files
Retrieved from "http://shore.sourceforge.net/wiki/index.php?title=SHORE_Subprograms&oldid=281"