Mercurial > repos > iuc > hicexplorer_hictraintadclassifier

annotate hicTrainTADClassifier.xml @ 0:2ddd36e02c20 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 11:13:37 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
1 <tool id="hicexplorer_hictraintadclassifier" name="@BINARY@" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
2 <description>train a TAD detection ML model</description>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
3 <macros>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
4 <token name="@BINARY@">hicTrainTADClassifier</token>
2ddd36e02c20 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>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
6 </macros>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
7 <expand macro="requirements" />
2ddd36e02c20 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[
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
9 #import re
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
10
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
11 @BINARY@
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
12 --matrices '$matrix_cooler_multiple'
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
13 --mode train_new
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
14 --domain_file '$domainFile'
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
15 --resolution $resolution
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
16 @CHROMOSOME_LIST@
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
17 --normalization_method $normalization_method_select
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
18 --threads @THREADS@
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
19
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
20 #if $protein_conditional.protein_selector == 'yes':
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
21 --protein_file '$proteinFile'
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
22 #if $protein_conditional.threshold:
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
23 --threshold $protein_conditional.threshold
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
24 #end if
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
25 #if $protein_conditional.leniency:
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
26 --leniency $protein_conditional.leniency
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
27 #end if
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
28 #end if
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
29
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
30 #if $ml_conditional.ml_selector == 'yes':
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
31 $ml_conditional.unselect_border_cases
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
32 $ml_conditional.concatenate_before_resample
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
33 $ml_conditional.use_cleanlab
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
34 --estimators_per_step $ml_conditional.estimators_per_step
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
35 --distance $ml_conditional.distance
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
36 --impute_value $ml_conditional.impute_value
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
37 --resampling_method $ml_conditional.sampling_method_selector
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
38 #end if
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
39 --out_file trained_model
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
40 ]]>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
41 </command>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
42 <inputs>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
43 <expand macro="matrix_cooler_multiple_macro" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
44 <param name="domainFile" format="tabular" type="data" multiple="true" label="Domain file or list of files containing tad boundaries"/>
2ddd36e02c20 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" type="select" label="Normalization method">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
46 <option value="obs_exp" selected="True">Observed / expected</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
47 <option value="range">0 - 1 range</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
48 </param>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
49 <param argument="--resolution" type="integer" min="0" max="100000000" label="Resolution of the matrix" help="The matrix resolution of the Hi-C interaction matrix." value="10000" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
50
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
51 <conditional name="protein_conditional">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
52 <param name="protein_selector" type="select" label="Consider protein locations">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
53 <option value="yes">Yes</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
54 <option value="no" selected="True">No</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
55 </param>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
56 <when value="yes">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
57 <param name="proteinFile" type="data" format="bed" label="Protein file in bed format" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
58 <param name="threshold" type="float" optional="True" label="Threshold" help="Consider only protein peaks with at least the threshold value"/>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
59 <param name="leniency" type="float" optional="True" label="Leniency" help="Leniency for protein quality check. Widens peaks of protein file by leniency*resolution"/>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
60 </when>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
61 <when value="no" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
62 </conditional>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
63
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
64 <conditional name="ml_conditional">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
65 <param name="ml_selector" type="select" label="Configure ML model options">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
66 <option value="yes">Yes</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
67 <option value="no" selected="True">No</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
68 </param>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
69 <when value="yes">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
70 <param argument="--unselect_border_cases" type="boolean" truevalue="--unselect_border_cases" falsevalue="" label="Unselect border cases" help="Set whether genes at the border of the matrix up to set distance will not be used for training and testing" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
71 <param argument="--concatenate_before_resample" type="boolean" truevalue="--concatenate_before_resample" falsevalue="" label="Concatenate before resample" help="Whether features build from matrix list are concatenated and resampled together or resampled separatly per matrix. Not important for random undersampling, but alter for other resampling methods and check if performance increases." />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
72 <param argument="--use_cleanlab" type="boolean" truevalue="--use_cleanlab" falsevalue="" label="Use cleanlab" help="Use Confident Learning with the cleanlab library" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
73 <param argument="--estimators_per_step" type="integer" min="5" max="1000" label="Estimators per step" help="How many estimators are added in each training step for the classifier" value="20" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
74 <param argument="--distance" type="integer" min="5" max="30" label="Distance" help="max distance between TADs to be used in calculation" value="15" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
75 <param argument="--impute_value" type="float" label="Resolution of the matrix" help="non-numerical float values in matrix will be replaced by this value" value="-1.0" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
76 <param name="sampling_method_selector" type="select" label="Configure ML model options">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
77 <option value="undersample_cluster_centroids">Undersample cluster centroids</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
78 <option value="undersample_random" selected="True">undersample random</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
79 <option value="passed_method">passed method</option>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
80 </param>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
81 </when>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
82 <when value="no" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
83 </conditional>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
84
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
85 <expand macro="chromosome_list" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
86
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
87 <param name="saved_classifier" format="binary" optional="True" type="data" label="Use a self-trained classifier"/>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
88
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
89 </inputs>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
90 <outputs>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
91 <data name="trained_classifier" from_work_dir="trained_model.BIN" format="binary" label="Trained classifier" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
92 </outputs>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
93 <tests>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
94 <test>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
95 <param name="matrix_cooler_multiple" value="hicTrainTADClassifier/small_test_matrix.cool" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
96 <param name="normalization_method_select" value="obs_exp" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
97 <param name="domainFile" value="hicTrainTADClassifier/multiFDR_dekker_domains.bed" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
98 <param name="resolution" value="10000" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
99 <conditional name="ml_conditional">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
100 <param name="ml_selector" value="yes" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
101 <param name="unselect_border_cases" value="true" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
102 </conditional>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
103 <conditional name="protein_conditional">
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
104 <param name="protein_selector" value="no" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
105 </conditional>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
106 <output name="trained_classifier" file="hicTrainTADClassifier/model.BIN" ftype="binary" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
107 </test>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
108 </tests>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
109 <help><![CDATA[
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
110
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
111 Train TAD predictor
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
112 ====================
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
113
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
114 This program can be used to train new classifiers for hicTADClassifier. These classifiers can later be run to call boundaries for TADs. By default, an EasyEnsembleClassifier as described in Liu et al.: “Exploratory Undersampling for Class-Imbalance Learning” will be trained, but you can pass any sklearn classifier that allows for a warm start. You may also vary the resampling method and a range of hyperparameters to fine tune the model. Do mind to set the correct normalization method and resolution for the classifier. The program will check and raise warnings, when resolutions and normalization methods are mixed up.
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
115 Also, a protein track file in the narrowPeak format with a threshold value may be passed to filter out low quality boundaries.
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
116
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
117 The resulting classifier will be pickled at the specified out_file. A quick example can be seen here, where we varied the feature distance:
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
118 ## <!-- <param name="proteinFile" value='hicTrainTADClassifier/ctcf_chr2.csv' /> -->
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
119
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
120 Usage
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
121 -----
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
122
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
123 .. code-block:: text
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
124
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
125 $ hicTrainTADClassifier -m 'train_new' -f 'my_test_matrix.cool' -d 'domains.bed' -o 'new_classifier.data' -n 'range' -r 10000 --distance 18
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
126
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
127
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
128 For more information about HiCExplorer please consider our documentation on readthedocs.io_.
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
129
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
130 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
131
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
132 ]]> </help>
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
133 <expand macro="citations" />
2ddd36e02c20 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 07802a6bd441d9da888cfb8283f8c2135704f7c9
iuc
parents:
diff changeset
134 </tool>