|
5
|
1 <tool id="segmentation" name="Segmentation and calling" force_history_refresh="True">
|
|
|
2 <description>of a previously normalized signal</description>
|
|
|
3 <requirement type="package" version="1.1.2">mpagenomics</requirement>
|
|
|
4 <command interpreter="python">
|
|
|
5 segmentation.py
|
|
|
6 #if $signalType.signal == "CN":
|
|
|
7 --nbcall '$signalType.nbcall'
|
|
|
8 --cellularity '$signalType.cellularity'
|
|
|
9 #else
|
|
|
10 --nbcall '3'
|
|
|
11 --cellularity '1.0'
|
|
|
12 #end if
|
|
|
13 --input '$input'
|
|
|
14 --new_file_path '$__new_file_path__'
|
|
|
15 --outputlog '$outputlog'
|
|
|
16 --output '$output'
|
|
|
17 --log '$log'
|
|
|
18 --outputgraph '$outputgraph'
|
|
|
19 --graph '$graph'
|
|
|
20 --method '$method'
|
|
|
21 --signalType '$signalType.signal'
|
|
|
22 --user_id '$__user_id__'
|
|
|
23
|
|
|
24 </command>
|
|
|
25 <inputs>
|
|
|
26 <param name="input" type="data" format="sef" label="Input Signal" help="see below for more information on file format"/>
|
|
|
27
|
|
|
28 <param name="method" type="select" label="Segmentation method" help="">
|
|
|
29 <option value="cghseg">cghseg</option>
|
|
|
30 <option value="PELT">PELT</option>
|
|
|
31 </param>
|
|
|
32
|
|
|
33 <conditional name="signalType">
|
|
|
34 <param name="signal" type="select" multiple="false" label="Signal type">
|
|
|
35 <option value="CN">CN</option>
|
|
|
36 <option value="fracB">fracB</option>
|
|
|
37 </param>
|
|
|
38 <when value="fracB"/>
|
|
|
39 <when value="CN">
|
|
|
40
|
|
|
41 <param name="nbcall" type="select" label="Number of calling classes" help="The number of levels to be used for calling. Either 3 (loss, normal, gain), 4 (including amplifications), 5 (including double deletions) ">
|
|
|
42 <option value="3">3</option>
|
|
|
43 <option value="4">4</option>
|
|
|
44 <option value="5">5</option>
|
|
|
45 </param>
|
|
|
46 <param name="cellularity" type="float" size="5" value="1" min="0" max="1" label="Cellularity" help="Ratio of tumor cells in the sample. Real value between 0 and 1"/>
|
|
|
47 </when>
|
|
|
48 </conditional>
|
|
|
49 <param name="outputgraph" type="select" label="Output figures">
|
|
|
50 <option value="TRUE">Yes</option>
|
|
|
51 <option value="FALSE">No</option>
|
|
|
52 </param>
|
|
|
53 <param name="outputlog" type="select" label="Output log">
|
|
|
54 <option value="TRUE">Yes</option>
|
|
|
55 <option value="FALSE">No</option>
|
|
|
56 </param>
|
|
|
57 </inputs>
|
|
|
58 <outputs>
|
|
|
59 <data format="scr" name="output" label="segmentation of ${input.name}" />
|
|
|
60 <data format="log" name="log" label="log of segmentation of ${input.name}">
|
|
|
61 <filter>outputlog == "TRUE"</filter>
|
|
|
62 </data>
|
|
|
63 <data format="pdf" name="graph" label="graph of segmentation of ${input.name}">
|
|
|
64 <filter>outputgraph == "TRUE"</filter>
|
|
|
65 </data>
|
|
|
66 </outputs>
|
|
|
67 <stdio>
|
|
|
68 <exit_code range="1:" level="fatal" description="See logs for more details" />
|
|
|
69 </stdio>
|
|
|
70 <help>
|
|
|
71
|
|
|
72 **What it does**
|
|
|
73 This tool segments normalized profiles provided by the user and labels segments found in the copy-number profiles.
|
|
|
74
|
|
|
75 Input format:
|
|
|
76
|
|
|
77 *A tabular text file containing 3 fixed columns and 1 column per sample:*
|
|
|
78
|
|
|
79 - chr: Chromosome.
|
|
|
80 - position: Genomic position (in bp)
|
|
|
81 - probeName: Probes names.
|
|
|
82 - One column per sample which contains the copy number profile for each sample
|
|
|
83
|
|
|
84 Output format:
|
|
|
85
|
|
|
86 *A tabular text file containing 7 columns which describe all the segments (1 line per segment):*
|
|
|
87
|
|
|
88 - sampleNames: Column names corresponding to samples in the input file.
|
|
|
89 - chrom: Chromosome of the segment.
|
|
|
90 - chromStart: Starting position (in bp) of the segment. This position is not included in the segment.
|
|
|
91 - chromEnd: Ending position (in bp) of the segment. This position is included in the segment.
|
|
|
92 - probes: Number of probes in the segment.
|
|
|
93 - means: Mean of the segment.
|
|
|
94 - calls: Calling of the segment (”double loss”, ”loss”, ”normal”, ”gain” or ”amplification”).
|
|
|
95
|
|
|
96 -----
|
|
|
97
|
|
|
98 **Citation**
|
|
|
99 If you use this tool please cite :
|
|
|
100
|
|
|
101 `Q. Grimonprez, A. Celisse, M. Cheok, M. Figeac, and G. Marot. MPAgenomics : An R package for multi-patients analysis of genomic markers, 2014. Preprint <http://fr.arxiv.org/abs/1401.5035>`_
|
|
|
102
|
|
|
103 If segmentation is performed with PELT, please also cite `R. Killick, P. Fearnhead, and I. A. Eckley. Optimal detection of changepoints with a linear computational cost. Journal of the American Statistical Association, 107(500):1590–1598, 2012. <http://arxiv.org/abs/1101.1438>`_
|
|
|
104
|
|
|
105 If segmentation is performed by cghseg, please cite `Picard, F., Robin, S., Lavielle, M., Vaisse, C., and Daudin, J.-J. (2005). A statistical approach for array CGH data analysis. BMC Bioinformatics, 6(1):27. <http://www.ncbi.nlm.nih.gov/pubmed/15705208>`_ ,
|
|
|
106 and also cite Rigaill, G. (2010). `Pruned dynamic programming for optimal multiple change-point detection. <http://arxiv.org/abs/1004.0887>`_
|
|
|
107
|
|
|
108 When using the labels of the segments, please cite CGHCall `M. A. van de Wiel, K. I. Kim, S. J. Vosse, W. N. van Wieringen, S. M. Wilting, and B. Ylstra. CGHcall: calling aberrations for array CGH tumor profiles. Bioinformatics, 23(7):892–894, 2007. <http://bioinformatics.oxfordjournals.org/content/23/7/892.abstract>`_
|
|
|
109
|
|
|
110 </help>
|
|
|
111 </tool>
|
