Mercurial > repos > bgruening > hicexplorer_chicqualitycontrol
comparison chicQualityControl.xml @ 2:7095bb186016 draft
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hicexplorer commit 4b602d427e0fc0da5353a4510798349de98e4ae4"
author | iuc |
---|---|
date | Wed, 11 Mar 2020 16:52:37 -0400 |
parents | 000ddd5f0f82 |
children | 0e149d0c112c |
comparison
equal
deleted
inserted
replaced
1:feb7f62a0ff9 | 2:7095bb186016 |
---|---|
4 <token name="@BINARY@">chicQualityControl</token> | 4 <token name="@BINARY@">chicQualityControl</token> |
5 <import>macros.xml</import> | 5 <import>macros.xml</import> |
6 </macros> | 6 </macros> |
7 <expand macro="requirements" /> | 7 <expand macro="requirements" /> |
8 <command detect_errors="exit_code"><![CDATA[ | 8 <command detect_errors="exit_code"><![CDATA[ |
9 | 9 |
10 #for $counter, $m in enumerate($matrix_h5_cooler_multiple): | 10 #for $counter, $m in enumerate($matrix_h5_cooler_multiple): |
11 ln -s '$m' ${counter}_matrix.$m.ext && | 11 ln -s '$m' ${counter}_matrix.$m.ext && |
12 #end for | 12 #end for |
13 #set $m = ' '.join([ '\'%s_matrix.%s\'' % ($counter, $matrix.ext) for $counter, $matrix in enumerate($matrix_h5_cooler_multiple) ]) | 13 #set $m = ' '.join([ '\'%s_matrix.%s\'' % ($counter, $matrix.ext) for $counter, $matrix in enumerate($matrix_h5_cooler_multiple) ]) |
14 | 14 |
15 @BINARY@ | 15 @BINARY@ |
16 | 16 |
17 --matrices $m | 17 --matrices $m |
18 --referencePoints '$referencePoints' | 18 --referencePoints '$referencePoints' |
19 --sparsity $sparsity | 19 --sparsity $sparsity |
27 && mv histogram.$image_file_format histogram | 27 && mv histogram.$image_file_format histogram |
28 && mv sparsity.$image_file_format sparsity | 28 && mv sparsity.$image_file_format sparsity |
29 ]]></command> | 29 ]]></command> |
30 <inputs> | 30 <inputs> |
31 <expand macro="matrix_h5_cooler_multiple_macro" /> | 31 <expand macro="matrix_h5_cooler_multiple_macro" /> |
32 | 32 |
33 <param argument="--referencePoints" type="data" format='interval' | 33 <param argument="--referencePoints" type="data" format='interval' |
34 label="Reference points" | 34 label="Reference points" |
35 help="Bed file contains all reference points which should be used to build the background model." /> | 35 help="Bed file contains all reference points which should be used to build the background model." /> |
36 <param argument="--sparsity" type="float" value="0.05" label="Sparsity threshold" help='Viewpoints with a sparsity less than given are considered of bad quality. If multiple matrices are given, the viewpoint is removed as soon as it is of bad quality in at least one matrix.'/> | 36 <param argument="--sparsity" type="float" value="0.05" label="Sparsity threshold" help='Viewpoints with a sparsity less than given are considered of bad quality. If multiple matrices are given, the viewpoint is removed as soon as it is of bad quality in at least one matrix.'/> |
37 | 37 |
38 <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.'/> | 38 <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.'/> |
39 | 39 |
40 <param name='dpi' type='integer' value='300' label='DPI for image' help='Change the default resolution of the plot.' optional='true'/> | 40 <param name='dpi' type='integer' value='300' label='DPI for image' help='Change the default resolution of the plot.' optional='true'/> |
41 <param name="image_file_format" type="select" label="Image output format"> | 41 <param name="image_file_format" type="select" label="Image output format"> |
42 <option value="png" selected="True">png</option> | 42 <option value="png" selected="True">png</option> |
43 <option value="svg">svg</option> | 43 <option value="svg">svg</option> |
44 <option value="pdf">pdf</option> | 44 <option value="pdf">pdf</option> |
45 </param> | 45 </param> |
46 | 46 |
47 </inputs> | 47 </inputs> |
48 <outputs> | 48 <outputs> |
49 <data name="raw_reference_points" from_work_dir="reference_points_raw_filter" format="interval" label="${tool.name} on [${on_string}]: Reference points raw"/> | 49 <data name="raw_reference_points" from_work_dir="reference_points_raw_filter" format="interval" label="${tool.name} on [${on_string}]: Reference points raw"/> |
50 <data name="rejected_reference_points" from_work_dir="reference_points_rejected_filter" format="interval" label="${tool.name} on [${on_string}]: Reference points rejected"/> | 50 <data name="rejected_reference_points" from_work_dir="reference_points_rejected_filter" format="interval" label="${tool.name} on [${on_string}]: Reference points rejected"/> |
51 <data name="accepted_reference_points" from_work_dir="reference_points" format="interval" label="${tool.name} on [${on_string}]: Reference points accepted"/> | 51 <data name="accepted_reference_points" from_work_dir="reference_points" format="interval" label="${tool.name} on [${on_string}]: Reference points accepted"/> |
65 <tests> | 65 <tests> |
66 <test> | 66 <test> |
67 <param name="matrix_h5_cooler_multiple" value="cHi-C/FL-E13-5_chr1.cool,cHi-C/MB-E10-5_chr1.cool"/> | 67 <param name="matrix_h5_cooler_multiple" value="cHi-C/FL-E13-5_chr1.cool,cHi-C/MB-E10-5_chr1.cool"/> |
68 <param name="referencePoints" value="cHi-C/referencePoints.bed"/> | 68 <param name="referencePoints" value="cHi-C/referencePoints.bed"/> |
69 <param name='sparsity' value='0.05'/> | 69 <param name='sparsity' value='0.05'/> |
70 | 70 |
71 <output name="accepted_reference_points" file="cHi-C/chicQualityControl/new_referencepoints.bed" ftype="interval" compare="sim_size" delta='40000'/> | 71 <output name="accepted_reference_points" file="cHi-C/chicQualityControl/new_referencepoints.bed" ftype="interval" compare="sim_size" delta='40000'/> |
72 <output name="raw_reference_points" file="cHi-C/chicQualityControl/new_referencepoints.bed_raw_filter" ftype="interval" compare="sim_size" delta='40000'/> | 72 <output name="raw_reference_points" file="cHi-C/chicQualityControl/new_referencepoints.bed_raw_filter" ftype="interval" compare="sim_size" delta='40000'/> |
73 <output name="rejected_reference_points" file="cHi-C/chicQualityControl/new_referencepoints.bed_rejected_filter" ftype="interval" compare="sim_size" delta='40000'/> | 73 <output name="rejected_reference_points" file="cHi-C/chicQualityControl/new_referencepoints.bed_rejected_filter" ftype="interval" compare="sim_size" delta='40000'/> |
74 <output name="plot_histrogram" file="cHi-C/chicQualityControl/histogram.png" ftype="png" compare='sim_size' delta='40000'/> | 74 <output name="plot_histrogram" file="cHi-C/chicQualityControl/histogram.png" ftype="png" compare='sim_size' delta='40000'/> |
75 <output name="plot_sparsity" file="cHi-C/chicQualityControl/sparsity.png" ftype="png" compare="sim_size" delta='40000'/> | 75 <output name="plot_sparsity" file="cHi-C/chicQualityControl/sparsity.png" ftype="png" compare="sim_size" delta='40000'/> |
79 <help><![CDATA[ | 79 <help><![CDATA[ |
80 | 80 |
81 Compute the quality of viewpoints | 81 Compute the quality of viewpoints |
82 ================================= | 82 ================================= |
83 | 83 |
84 Computes the sparsity of each viewpoint to determine the quality. A viewpoint is considered of bad quality if it is too sparse i.e. there are too many locations with no interactions recorded. | 84 Computes the sparsity of each viewpoint to determine their quality. A viewpoint is considered of bad quality if it is too sparse i.e. there are too many locations with no interactions recorded. |
85 | 85 |
86 This script outputs five files: A plot with the sparsity distribution per matrix, a plot with the sparsity distribution as histograms and a filtered reference points file. Additional, the raw filter data and the rejected viewpoints are returned. | 86 This script outputs five files: A plot with the sparsity distribution per matrix, a plot with the sparsity distribution as histograms and a filtered reference points file. Additional, the raw filter data and the rejected viewpoints are returned. |
87 | 87 |
88 An example usage is: | 88 An example usage is: |
89 | 89 |
90 `$ chicQualityControl -m matrix1.h5 matrix2.h5 -rp referencePointsFile.bed --range 20000 40000 --sparsity 0.01 -o referencePointFile_QC_passed.bed` | 90 `$ chicQualityControl -m matrix1.h5 matrix2.h5 -rp referencePointsFile.txt --range 20000 40000 --sparsity 0.01 -o referencePointFile_QC_passed.txt` |
91 | 91 |
92 For more information about HiCExplorer please consider our documentation on readthedocs.io_ | 92 For more information about HiCExplorer please consider our documentation on readthedocs.io_ |
93 | 93 |
94 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html | 94 .. _readthedocs.io: http://hicexplorer.readthedocs.io/en/latest/index.html |
95 ]]></help> | 95 ]]></help> |