Mercurial > repos > iuc > hicexplorer_hictadclassifier

annotate hicTADClassifier.xml @ 0:17717d8b8360 draft default tip

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 07802a6bd441d9da888cfb8283f8c2135704f7c9
author iuc
date Wed, 18 Oct 2023 10:28:34 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
1 <tool id="hicexplorer_hictadclassifier" name="@BINARY@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
2 <description>TAD detection based on ML models</description>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
3 <macros>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
4 <token name="@BINARY@">hicTADClassifier</token>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
5 <import>macros.xml</import>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
6 </macros>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
7 <expand macro="requirements" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
9
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
10 @BINARY@
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
11 --matrices '$matrix'
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
12
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
13 @CHROMOSOME_LIST@
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
14 --normalization_method $normalization_method_select
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
15 --threads @THREADS@
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
16 #if $saved_classifier:
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
17 --saved_classifier $saved_classifier
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
18 #end if
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
19 --out_file predicted.txt
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
20 ]]>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
21 </command>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
22 <inputs>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
23 <param name="matrix" type="data" format="cool" label="Hi-C matrix" help="This tool supports only the cooler file format" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
24 <param name="normalization_method_select" type="select" label="Normalization method">
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
25 <option value="obs_exp" selected="True">Observed / expected</option>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
26 <option value="range">0 - 1 range</option>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
27 </param>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
28 <expand macro="chromosome_list" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
29
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
30 <param name="saved_classifier" format="binary" optional="True" type="data" label="Use a self-trained classifier"/>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
31
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
32 </inputs>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
33 <outputs>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
34 <data name="predicted_tad" from_work_dir="predicted.txt" format="txt" label="predicted TADs" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
35 </outputs>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
36 <tests>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
37 <test>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
38 <param name="matrix" value="small_test_matrix.cool" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
39 <param name="normalization_method_select" value="obs_exp" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
40 <output name="predicted_tad" file="hicTADClassifier/predicted.txt" ftype="txt" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
41 </test>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
42
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
43 <test>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
44 <param name="matrix" value="small_test_matrix.cool" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
45 <param name="normalization_method_select" value="obs_exp" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
46 <param name="saved_classifier" value="hicTADClassifier/unittest_classifier.BIN" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
47
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
48 <output name="predicted_tad" file="hicTADClassifier/predicted_second_classifier.txt" ftype="txt" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
49 </test>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
50 </tests>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
51 <help><![CDATA[
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
52
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
53 Predict TADs based on a ML model
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
54 ================================
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
55
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
56 Uses Supervised Learning to call TAD boundaries. One Hi-C matrix can be passed, from which a BED file will be produced containing the predicted boundary positions.
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
57 By default, a EasyEnsembleClassifier as described in Liu et al.: “Exploratory Undersampling for Class-Imbalance Learning” will be used to call TADs.
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
58 Internally this classifier relies on Resampling, Boosting and Bagging.
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
59 Passed matrices will be observed/expected normalized by default. Alternatively, a 0 -1 range normalization can be used. Currently, only classifiers for 10, 25, 50 and 100 kb resolution are provided. For building own classifiers or tune existing ones, hicTrainClassifier can be used and passed with the saved_classifer argument. A simple usage example can be seen here:
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
60
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
61 Usage
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
62 -----
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
63
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
64 .. code-block:: text
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
65
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
66 $ hicTADClassifier -m my_matrix.cool -o predictions --normalization_method obs_exp
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
67
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
68
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
69 For more information about HiCExplorer please consider our documentation on readthedocs.io_.
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
70
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
71 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
72
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
73 ]]> </help>
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
74 <expand macro="citations" />
17717d8b8360 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
75 </tool>