annotate cnv_sim.xml @ 4:4a4d2b78eb55 draft

Main Python Code
author ahosny
date Sat, 06 Aug 2016 15:25:34 -0400
parents 066299035353
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
1 <tool id="cnvsim" name="Simulate CNV" version="0.9.0">
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
2 <description>in NGS short reads </description>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
3 <command interpreter="python" detect_errors="exit_code">
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
4 #if $type.simulation_type=="whole_genome"
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
5 cnv-sim.py -n $number_of_reads -l $read_length -g $regions_count -a $amplifications -d $deletions -min $minimum -max $maximum genome $reference
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
6 #else
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
7 cnv-sim.py -n $number_of_reads -l $read_length -g $regions_count -a $amplifications -d $deletions -min $minimum -max $maximum exome $reference $target
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
8 #end if
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
9 </command>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
10 <inputs>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
11 <conditional name="type">
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
12 <param name="simulation_type" type="select" label="Simulation Type">
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
13 <option value="whole_genome">CNV Simulation in Whole Genome</option>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
14 <option value="whole_exome">CNV Simulation in Exome Regions</option>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
15 </param>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
16 <when value="whole_genome">
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
17 <param format="fasta" name="reference" type="data" label="Reference Genome" help="Reference genome to generate reads from"/>
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
18 </when>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
19 <when value="whole_exome">
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
20 <param format="fasta" name="reference" type="data" label="Reference Genome" help="Reference genome to generate reads from"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
21 <param format="bed" name="target" type="data" label="Target Regions" help="a list of exonic regions"/>
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
22 </when>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
23 </conditional>
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
24 <param name="number_of_reads" type="integer" value="100000" label="Number of Reads" help="determines the number of reads to be generated for the control and simulated CNV (approximately)"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
25 <param name="read_length" type="integer" value="100" label="Read Length (bp)" help="determines the read length fot the generated FASTQ files"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
26
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
27 <param name="regions_count" type="integer" value="30" label="Regions Count" help="determines how many randomly-generated regions will show CNVs"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
28 <param name="amplifications" type="float" value="0.5" label="Percentage of amplifications" help="determines what fraction of the regions will show amplifications (range: 0.0-1.0)"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
29 <param name="deletions" type="float" value="0.2" label="Percentage of deletions" help="determines what fraction of the regions will show deletions (range: 0.0-1.0)"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
30 <param name="minimum" type="integer" value="3" label="Variation minimum" help="determines the minumum number of amplifications/deletions introduced in each region"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
31 <param name="maximum" type="integer" value="10" label="Variation maximum" help="determines the maximum number of amplifications/deletions introduced in each region"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
32
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
33 </inputs>
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
34 <outputs>
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
35 <data format="bed" name="cnv_list" from_work_dir="test/CNVList.bed" label="CNV List from ${tool.name} on ${on_string}"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
36 <data format="fastq" name="control_1" from_work_dir="test/control_1.fastq" label="Control reads 1 from ${tool.name} on ${on_string}"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
37 <data format="fastq" name="control_2" from_work_dir="test/control_2.fastq" label="Control reads 2 from ${tool.name} on ${on_string}"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
38 <data format="fastq" name="cnv_1" from_work_dir="test/cnv_1.fastq" label="CNV reads 1 from ${tool.name} on ${on_string}"/>
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
39 <data format="fastq" name="cnv_2" from_work_dir="test/cnv_2.fastq" label="CNV reads 2 from ${tool.name} on ${on_string}"/>
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
40 </outputs>
3
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
41 <help><![CDATA[
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
42 .. class:: infomark
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
43 '''TIP''' This tool requires *fasta* format.
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
44 ----
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
45 **CNV Simulator**
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
46 In genomics, Copy Number Variations (CNVs) is a type of structural variation in a genome where sections of the genome are repeated. The number if repetitions (duplications) varies between individuals in the human population.
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
47
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
48 The Copy Number Variation Simulator (CNV Sim) is a tool used to generate a set of artificial DNA fragments for Next Generation Sequencing (NGS) read simulation. When aligned back to the reference genome, the artificial generated reads show variations in the CNV regions. Variations can be either amplifications of deletions.
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
49
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
50 CNV-Sim offers two types of simulation:
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
51 1. CNV simulation in whole genome. CNV-Sim wraps the functionality of ART to introduce variations in the genome.
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
52 2. CNV simulation in whole exome. CNV-Sim wraps the functionality of Wessim to introduce variations in the targets.
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
53
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
54 Homepage: http://nabavilab.github.io/CNV-Sim/
066299035353 initial CNV Sim tool definition file
ahosny
parents: 2
diff changeset
55 ]]></help>
2
8216e150d1aa initial CNV-Sim tool definition (0.9.0)
ahosny
parents:
diff changeset
56 </tool>