Mercurial > repos > bgruening > hicexplorer_chicviewpointbackgroundmodel

annotate chicViewpointBackgroundModel.xml @ 4:51447a1d38ed draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit db84cc85222518217286b42262935edd3a49c98e"
author iuc
date Fri, 14 Aug 2020 05:43:39 -0400
parents 7fe1a401d833
children 628259b7ffb4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
1 <tool id="hicexplorer_chicviewpointbackgroundmodel" name="@BINARY@" version="@WRAPPER_VERSION@.0">
1
91abc3b2e948 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 5744259254d4254a29cb7a6687fbbfd103301064"
bgruening
parents: 0
diff changeset
2 <description>compute a background model for cHi-C / HiChIP data</description>
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
3 <macros>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
4 <token name="@BINARY@">chicViewpointBackgroundModel</token>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
5 <import>macros.xml</import>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
6 </macros>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
2
b9cdce1e57a1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 1
diff changeset
9
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
10 #for $counter, $m in enumerate($matrix_h5_cooler_multiple):
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
11 ln -s '$m' '${counter}_matrix.$m.ext' &&
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
12 #end for
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
13 #set $m = ' '.join([ '\'%s_matrix.%s\'' % ($counter, $matrix.ext) for $counter, $matrix in enumerate($matrix_h5_cooler_multiple) ])
2
b9cdce1e57a1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 1
diff changeset
14
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
15 @BINARY@
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
16
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
17 --matrices $m
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
18 --averageContactBin $averageContactBin
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
19 --fixateRange $fixateRange
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
20 --referencePoints '$referencePoints'
3
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
21 $truncateZeros
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
22 --threads @THREADS@
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
23 --outFileName background.txt
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
24 ]]></command>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
25 <inputs>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
26 <expand macro="matrix_h5_cooler_multiple_macro" />
2
b9cdce1e57a1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 1
diff changeset
27
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
28 <param argument="--referencePoints" type="data" format='interval'
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
29 label="Reference points"
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
30 help="Bed file contains all reference points which should be used to build the background model." />
2
b9cdce1e57a1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 1
diff changeset
31 <param argument="--averageContactBin" type="integer" value="5" label="Average contacts window size" help='Average the contacts of n bins via a sliding window approach.'/>
b9cdce1e57a1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 1
diff changeset
32 <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.'/>
3
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
33 <param name='truncateZeros' type='boolean' truevalue='--truncateZeros' falsevalue="" checked="false" label="Truncate zeros"
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
34 help="Set this parameter if you want truncate zeros to fight over dispersion."/>
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
35 </inputs>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
36 <outputs>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
37 <data name="background" from_work_dir="background.txt" format="tabular" label="${tool.name} on [${on_string}]: Background model"/>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
38 </outputs>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
39 <tests>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
40 <test>
3
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
41 <param name="matrix_h5_cooler_multiple" value="cHi-C/FL-E13-5_chr1.cool,cHi-C/MB-E10-5_chr1.cool"/>
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
42 <param name="referencePoints" value="cHi-C/referencePoints.bed"/>
3
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
43 <output name="background" file="cHi-C/background.txt" ftype="tabular" compare="sim_size" delta='40000'/>
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
44 </test>
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
45 <test>
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
46 <param name="matrix_h5_cooler_multiple" value="cHi-C/FL-E13-5_chr1.cool,cHi-C/MB-E10-5_chr1.cool"/>
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
47 <param name="truncateZeros" value="True"/>
7fe1a401d833 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3d3fe0c7636592f01981d491dc8ff44bb55c1750"
iuc
parents: 2
diff changeset
48 <param name="referencePoints" value="cHi-C/referencePoints.bed"/>
2
b9cdce1e57a1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
iuc
parents: 1
diff changeset
49 <output name="background" file="cHi-C/background.txt" ftype="tabular" compare="sim_size" delta='40000'/>
0
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
50 </test>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
51 </tests>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
52 <help><![CDATA[
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
53
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
54 Compute a background model for cHi-C data analysis
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
55 ==================================================
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
56
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
57 chicViewpointBackgroundModel computes for all given samples with all reference points a background model. For all relative distances to a reference point
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
58 a negative binomial distribution is fitted. Moreover, for each relative distance to a reference point the average value for this location is computed. Both
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
59 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.
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
60
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
61 The background distributions are fixed at `--fixateRange` i.e. all distances lower / higher than this value use the fixed background distribution.
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
62
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
63 For more information about HiCExplorer please consider our documentation on readthedocs.io_
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
64
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
65 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
66 ]]></help>
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
67 <expand macro="citations" />
bd11c6a972ef "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 3b41d687ff30583540d055f6995de00530cca81d-dirty"
bgruening
parents:
diff changeset
68 </tool>