annotate cnv_sim.xml @ 16:7e8047d291e4 draft

Uploaded
author ahosny
date Wed, 07 Sep 2016 09:34:53 -0400
parents 12eb1e77bcfa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
1 <tool id="cnvsim" name="Simulate CNV" version="0.9.2">
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
2 <description>in NGS short reads </description>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
3 <command interpreter="python" detect_errors="exit_code">
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
4 #if $type.simulation_type=="whole_genome"
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
5 cnv-sim.py -n $number_of_reads -l $read_length -g $regions_count -a $amplifications_percentage -d $deletions_percentage -cn_min $minimum_copy_number -cn_max $maximum_copy_number -r_min $minimum_region_length -r_max $maximum_region_length genome $reference
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
6 #else
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
7 cnv-sim.py -n $number_of_reads -l $read_length -g $regions_count -a $amplifications_percentage -d $deletions_percentage -cn_min $minimum_copy_number -cn_max $maximum_copy_number -r_min $minimum_region_length -r_max $maximum_region_length exome $reference $target
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
8 #end if
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
9 </command>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
10 <inputs>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
11 <conditional name="type">
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
12 <param name="simulation_type" type="select" label="Simulation Type">
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
13 <option value="whole_genome">CNV Simulation in Whole Genome Sequencing</option>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
14 <option value="targeted_exome">CNV Simulation in Targeted Exome Sequencing</option>
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
15 </param>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
16 <when value="whole_genome">
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
17 <param format="fasta" name="reference" type="data" label="Reference Genome" help="Reference genome to generate reads from"/>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
18 </when>
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
19 <when value="targeted_exome">
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
20 <param format="fasta" name="reference" type="data" label="Reference Genome" help="Reference genome to generate reads from"/>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
21 <param format="bed" name="target" type="data" label="Target Regions" help="a list of exonic regions"/>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
22 </when>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
23 </conditional>
31047e84cc0d Uploaded
ahosny
parents:
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)"/>
31047e84cc0d Uploaded
ahosny
parents:
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"/>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
26
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
27 <param name="regions_count" type="integer" value="30" label="Regions Count" help="determines how many randomly-generated regions will show CNVs"/>
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
28 <param name="minimum_region_length" type="integer" value="1000" label="Minimum Region Length" help="Minimum length of each CNV region"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
29 <param name="maximum_region_length" type="integer" value="100000" label="Maximum Region Length" help="Minimum length of each CNV region"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
30 <param name="amplifications_percentage" type="float" value="0.5" label="Percentage of amplifications" help="determines what fraction of the regions will show amplifications (range: 0.0-1.0)"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
31 <param name="deletions_percentage" type="float" value="0.5" label="Percentage of deletions" help="determines what fraction of the regions will show deletions (range: 0.0-1.0)"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
32 <param name="minimum_copy_number" type="integer" value="3" label="Variation minimum" help="determines the minumum number of amplifications/deletions introduced in each region"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
33 <param name="maximum_copy_number" type="integer" value="10" label="Variation maximum" help="determines the maximum number of amplifications/deletions introduced in each region"/>
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
34
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
35 </inputs>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
36 <outputs>
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
37 <data format="bed" name="cnv_list" from_work_dir="simulation_output/copynumber.bed" label="CNV List from ${tool.name} on ${on_string}"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
38 <data format="fastq" name="control_1" from_work_dir="simulation_output/control_1.fastq" label="Control reads 1 from ${tool.name} on ${on_string}"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
39 <data format="fastq" name="control_2" from_work_dir="simulation_output/control_2.fastq" label="Control reads 2 from ${tool.name} on ${on_string}"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
40 <data format="fastq" name="cnv_1" from_work_dir="simulation_output/cnv_1.fastq" label="CNV reads 1 from ${tool.name} on ${on_string}"/>
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
41 <data format="fastq" name="cnv_2" from_work_dir="simulation_output/cnv_2.fastq" label="CNV reads 2 from ${tool.name} on ${on_string}"/>
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
42 </outputs>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
43 <help><![CDATA[
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
44 .. class:: infomark
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
45 '''TIP''' This tool requires *fasta* format.
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
46 ----
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
47 **CNV Simulator**
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
48 In genomics, Copy Number Variations (CNVs) is a type of structural variation in a genome where sections of the genome are duplicated or deleted. The number of variations (duplications/deletions) varies between individuals in the human population.
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
49
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
50 The Copy Number Variation Simulator (CNV-Sim) is a simulation tool that extends the functionality of existing next-generation sequencing read simulators to introduce copy number variations in the generated reads. The resulting reads encompass amplifications as well as deletions according to a predefined list of variant regions.
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
51
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
52 CNV-Sim aids testing and benchmarking tools for copy number variation detection and analysis. The tool offers two types of simulation:
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
53
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
54 CNV-Sim offers two types of simulation:
12
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
55 1. CNV simulation in whole genome. CNV-Sim utilizes the functionality of ART to introduce variations in the genome.
12eb1e77bcfa Uploaded definition file
ahosny
parents: 8
diff changeset
56 2. CNV simulation in targeted exome. CNV-Sim utilizes the functionality of Wessim to introduce variations in the targets.
8
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
57
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
58 Homepage: http://nabavilab.github.io/CNV-Sim/
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
59 ]]></help>
31047e84cc0d Uploaded
ahosny
parents:
diff changeset
60 </tool>