annotate VarAmpliCNV_CallCNVs.xml @ 1:5c324f9a4e20 draft default tip

Uploaded
author geert-vandeweyer
date Fri, 25 Sep 2020 08:30:57 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
1 <tool id="VarAmpliCNV_CallCNVs" name="Call CNVs" version="0.1.0" >
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
2 <requirements>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
3 <container type="docker">cmgantwerpen/varamplicnv:1.0.0</container>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
4 </requirements>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
6 ## make output folder.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
7 mkdir Output
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
8
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
9 &&
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
10
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
11 varAmpliCNV.R
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
12
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
13 ## counts object
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
14 -i $RData
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
15
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
16 ## deduped amplicons.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
17 -b $BedFile
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
18
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
19 ## Gene information
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
20 -r $RoiFile
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
21
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
22 ## GC content
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
23 -c $GcFile
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
24
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
25 ## genders (if specified)
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
26 #if $GenderFile
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
27 -s $GenderFile
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
28 #end if
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
29
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
30 ## output folder
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
31 -o Output
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
32
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
33 ## variance to remove
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
34 -p $VarProp
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
35
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
36 ## analysis type
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
37 -n $aTypeSelect.aType
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
38
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
39 ## thresholds
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
40 -d $aTypeSelect.delT
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
41 -D $aTypeSelect.dupT
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
42
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
43 ]]></command>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
44 <inputs>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
45 <param name="RData" type="data" format="rdata" optional="false" label="Sample Amplicon Counts" help="This file is created by the VarAmpliCNV 'Merge Counts' tool." />
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
46 <param name="BedFile" type="data" format="bed" optional="false" label="Amplicon BED file (duplicates removed)" help="This file is created by the VarAmpliCNV 'annotate' tool." />
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
47 <param name="RoiFile" type="data" format="bed" optional="false" label="ROI-Amplicon file" help="This file is created by the VarAmpliCNV 'annotate' tool." />
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
48 <param name="GcFile" type="data" format="txt" optional="false" label="Amplicon GC content" help="This file is created by the VarAmpliCNV 'Get GC Content' tool."/>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
49 <param name="GenderFile" type="data" format="txt" optional="true" label="Sample Genders" help="Sample genders for handling X-CNVs. See Documentation for format information"/>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
50 <param name="VarProp" type="float" value="0.8" label="Fraction of Variance to remove during MDS" help="Default: 0.8" />
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
51 <conditional name="aTypeSelect">
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
52 <param name="aType" type="select" label="Analysis Type" help="Use 'Direct' Segmentation (pure CBS), or apply post-segmentation 'AOF' (Amplicon Overlap Filtering)">
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
53 <option value='0'>Direct Segmentation</option>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
54 <option value='1' selected="TRUE">Amplicon Overlap Filtering</option>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
55 </param>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
56 <when value='0'>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
57 <param name="delT" value='-0.5' label="LogR Threshold for Deletions" type='float'/>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
58 <param name="dupT" value="0.5" label="LogR Threshold for Duplications" type='float'/>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
59 </when>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
60 <when value='1'>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
61 <param name="delT" value="-0.2" label="LogR Threshold for Deletions" type='float'/>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
62 <param name="dupT" value="0.38" label="LogR Threshold for Duplications" type='float'/>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
63 </when>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
64 </conditional>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
65 </inputs>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
66 <outputs>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
67 <data name="outfile" format="pdf" label="VarAmpliCNV on ${on_string}: Results" >
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
68 <discover_datasets pattern="__designation_and_ext__" directory="Output" visible="true" assign_primary_output="true" />
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
69 </data>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
70 </outputs>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
71 <help>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
72 **VarAmpliCNV : Call CNVs**
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
73
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
74 During CNV calling read counts are normalized over all samples inluced during "count merging", a set fraction of variance is removed and circular binary segmentation is applied to identify CNVs. If specified, a post-processing step is applied to take amplicon size and overlap into account to estimate reliability of the event. Passing CNVs are plotted gene-by-gene.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
75
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
76 **Parameters are :**
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
77
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
78 * Sample Amplicon Counts (RData) : The result from the 'Merge Counts' tool. It contains a raw sample-by-amplicon count matrix.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
79 * Amplicon BED file (BED) : This is the *exact* BED file provided by HaloPlex for the used library, with duplicates removed using the VarAmpliCNV "Annotate" tool.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
80 * ROI file (BED) : This is the *exact* BED file provided by HaloPlex for the used library, with duplicates removed and annotated with gene symbols using the VarAmpliCNV "Annotate" tool.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
81 * Amplicon GC Content (txt) : GC-content of individual amplicons, used for count correction. Generated using VarAmpliCNV 'Amplicon GC-Content' tool.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
82 * Sample Genders (txt) : Optional. If specified, build gender-specific normalization sets for X and Y chromosomes. Format is tab-separated : SamplenName&lt;tab&gt;M/F/U
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
83 * Fraction of Variance to Remove : Using an approach similar to Principal component analysis, a preset fraction of noise is removed from the data. Higher values typically result in less CNVs.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
84 * Analysis Type : Direct Segmentation applies only CBS and will not plot results. Amplicon Overlap Filtering is a post-processing filter to improve specificity, and will also enable plotting. The full CBS-results are always returned for manual inspection.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
85 * Thresholds : Set mininal values for LogR-based filtering of the called Segments.
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
86
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
87
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
88 **Output files :**
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
89
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
90 * Parameter_settings : Overview of set and derived settings + a list of discarded samples
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
91 * Plots.Quality_Measures : Quality metrics: coverage, variance by PC, GC-coverage-correlation
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
92 * Plots.Results : Gene-based CNV plots for segments passing the filters (if AOF is activated)
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
93 * Table.Results.Full : Full CBS results
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
94 * Table.Results.Filtered : Filtered CBS results (on LogR).
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
95 </help>
5c324f9a4e20 Uploaded
geert-vandeweyer
parents:
diff changeset
96 </tool>