annotate chicViewpointBackgroundModel.xml @ 0:722ac5ab3dd5 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
author iuc
date Mon, 09 Dec 2019 10:35:28 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
1 <tool id="hicexplorer_chicviewpointbackgroundmodel" name="@BINARY@" version="@WRAPPER_VERSION@.0">
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
2 <description>validate detected loops with protein peaks.</description>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
3 <macros>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
4 <token name="@BINARY@">chicViewpointBackgroundModel</token>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
5 <import>macros.xml</import>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
6 </macros>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
7 <expand macro="requirements" />
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
9
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
10 #for $counter, $m in enumerate($matrix_h5_cooler_multiple):
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
11 ln -s '$m' '${counter}_matrix.$m.ext' &&
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
12 #end for
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
13 #set $m = ' '.join([ '\'%s_matrix.%s\'' % ($counter, $matrix.ext) for $counter, $matrix in enumerate($matrix_h5_cooler_multiple) ])
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
14
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
15 @BINARY@
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
16
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
17 --matrices $m
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
18 --averageContactBin $averageContactBin
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
19 --fixateRange $fixateRange
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
20 --referencePoints '$referencePoints'
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
21 --threads @THREADS@
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
22 --outFileName background.txt
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
23 ]]></command>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
24 <inputs>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
25 <expand macro="matrix_h5_cooler_multiple_macro" />
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
26
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
27 <param argument="--referencePoints" type="data" format='interval'
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
28 label="Reference points"
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
29 help="Bed file contains all reference points which should be used to build the background model." />
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
30 <param argument="--averageContactBin" type="integer" value="5" label="Average contacts window size" help='Average the contacts of n bins via a sliding window approach.'/>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
31 <param argument="--fixateRange" type="integer" value="500000" label="Clip background distance" help='Fixate score of background model starting at distance x. E.g. all values greater 500kb are set to the value of the 500kb bin.'/>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
32
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
33 </inputs>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
34 <outputs>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
35 <data name="background" from_work_dir="background.txt" format="tabular" label="${tool.name} on [${on_string}]: Background model"/>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
36 </outputs>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
37 <tests>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
38 <test>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
39 <param name="matrix_h5_cooler_multiple" value="cHi-C/FL-E13-5_chr1.cool,cHi-C/MB-E10-5_chr1.cool"/>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
40
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
41 <param name="referencePoints" value="cHi-C/referencePoints.bed"/>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
42
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
43 <output name="background" file="cHi-C/background.bed" ftype="tabular" compare="sim_size" delta='40000'/>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
44 </test>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
45 </tests>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
46 <help><![CDATA[
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
47
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
48 Compute a background model for cHi-C data analysis
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
49 ==================================================
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
50
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
51 chicViewpointBackgroundModel computes for all given samples with all reference points a background model. For all relative distances to a reference point
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
52 a negative binomial distribution is fitted. Moreover, for each relative distance to a reference point the average value for this location is computed. Both
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
53 background models are used, the first one for p-value and significance computation, the second one to filter out interactions with a less x-fold over mean.
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
54
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
55 The background distributions are fixed at `--fixateRange` i.e. all distances lower / higher than this value use the fixed background distribution.
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
56
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
57 For more information about HiCExplorer please consider our documentation on readthedocs.io_
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
58
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
59 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
60 ]]></help>
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
61 <expand macro="citations" />
722ac5ab3dd5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 9e4e8de0e003fc15f5bae3648232c2a8a57e6391"
iuc
parents:
diff changeset
62 </tool>