annotate track-mapper.xml @ 25:1fdfbe87a959 draft default tip

Uploaded
author s-kaufmann
date Tue, 19 Aug 2014 08:18:03 -0400
parents 8a4190457eb7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
1 <tool id="SyntenyTrackMapper" name="SyntenyTrackMapper" version="1.0.0">
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
2 <description>Compares tracks in .bed-format between two species based on the synteny-based mapping</description>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
3
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
4 <requirements>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
5 <requirement type="set_environment">JAR_PATH</requirement>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
6 </requirements>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
7
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
8 <command>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
9 #if $score.exists == "yes" #java -cp \$JAR_PATH/syntenyMapper.jar de/tum/wzw/trackmapping/TrackMapper $bedfile1 $bedfile2 $mappingFile $score.scoreCol $out_file1
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
10 #else # java -cp \$JAR_PATH/syntenyMapper.jar de/tum/wzw/trackmapping/TrackMapper $bedfile1 $bedfile2 $mappingFile -1 $out_file1
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
11 #end if
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
12 </command>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
13
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
14 <inputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
15 <param name="mappingFile" format="tabular" type="data" label="Mapped genes (SyntenyMapper output1)"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
16 <param name="bedfile1" format="bed" type="data" label="Track in .bed-format, species1"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
17 <param name="bedfile2" format="bed" type="data" label="Track in .bed-format, species2"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
18 <conditional name="score">
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
19 <param name="exists" type="select" label=".bed files contain scores">
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
20 <option value="yes">Yes</option>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
21 <option value="no">No</option>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
22 </param>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
23 <when value="yes">
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
24 <param name="scoreCol" type="data_column" data_ref="bedfile1" label="Score column"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
25 </when>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
26 </conditional>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
27 </inputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
28 <outputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
29 <data format="tabular" name="out_file1" label="Similarity track"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
30 </outputs>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
31 <tests>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
32 <test>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
33 <param name="mappingFile" value="Gene_mapping1.out"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
34 <param name="bedfile1" value="encode-broad-histone-h3k4me1.hg19.bed"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
35 <param name="bedfile2" value="encode-caltech-h3k4me1.mm10.bed"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
36 <param name="scoreCol" value="4"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
37 <output name="out_file1" file="Similarity_track.out"/>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
38 </test>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
39 </tests>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
40 <help>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
41
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
42 This tool utilizes the gene-based mapping generated with SyntenyMapper to calculate a similarity measure of a track's average gene/intergenic region coverage for two species.
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
43
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
44 ----
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
45
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
46 **Input**
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
47
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
48 .. class:: warningmark
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
49
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
50 Please make sure that your bed file's genome build is equal to the build used to generate the mapper (*TIP:* Use LiftOver to make it match)
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
51
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
52 .. class:: infomark
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
53
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
54 Species 1 and 2 are equal to those chosen by you for SyntenyMapper; if you are unsure about the order, please take a look at the first two rows of the file containing mapped genes.
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
55
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
56 .. class:: warningmark
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
57
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
58 Correct input format has to be generated with the SyntenyMapper tool.
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
59
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
60 Mapped genes is SyntenyMapper's first output file containing 12 columns in the following format:
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
61
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
62 +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
63 |#Species1: homo_sapiens |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
64 +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
65 |#Species2: mus_musculus |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
66 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
67 |#ID |SyntenyID |ENSEMBL_ID_species1 |Chrom_species1 |Start_species1 |End_species1 |ENSEMBL_ID_species2 |Chrom_species2 |Start_species2 |End_species2 |Type |splitted |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
68 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
69 |0 |445330001 |ENSG00000068793 |15 |22892005 |23006016 |ENSMUSG00000030447 |7 |55841745 |55930700 |gene |'no' |
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
70 +----+----------+--------------------+---------------+---------------+-------------+--------------------+---------------+---------------+-------------+-----+---------+
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
71
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
72 ----
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
73
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
74 **Mapping**
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
75
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
76 The .bed-entries are divided into segments according to mapping elements (usually genes and intergenic regents), normalized using standard score, and absolute difference between tracks is calculated as a similarity measure. The similarity score will be in column 9 of the resulting similarity track file. Every gene that is not covered by elements in at least one organism has the score -1. Mean score difference for all entries that overlap with at least one element is given in the first comment line of the output.
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
77
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
78 </help>
8a4190457eb7 Uploaded
s-kaufmann
parents:
diff changeset
79 </tool>