annotate vsnp_statistics.xml @ 0:c21d338dbdc4 draft

Uploaded
author greg
date Tue, 21 Apr 2020 10:19:53 -0400
parents
children 14e29f7d59ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
1 <tool id="vsnp_statistics" name="vSNP: statistics" version="1.0.0">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
2 <description></description>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
3 <requirements>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
4 <requirement type="package" version="0.5.1">humanize</requirement>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
5 <requirement type="package" version="1.16.5">numpy</requirement>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
6 <requirement type="package" version="0.25.3">pandas</requirement>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
7 </requirements>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
9 #import os
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
10 #import re
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
11 #set gzipped = 'false'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
12 #set input_type = $input_type_cond.input_type
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
13 #set input_idxstats_dir = 'input_idxstats'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
14 #set input_metrics_dir = 'input_metrics'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
15 #set input_reads_dir = 'input_reads'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
16 #set output_dir = 'output'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
17 mkdir -p $input_idxstats_dir &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
18 mkdir -p $input_metrics_dir &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
19 mkdir -p $input_reads_dir &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
20 mkdir -p $output_dir &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
21 #if str($input_type) == "single":
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
22 #set read_type_cond = $input_type_cond.read_type_cond
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
23 #set read1 = $read_type_cond.read1
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
24 #set read1_identifier = re.sub('[^\s\w\-]', '_', str($read1.element_identifier))
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
25 #if str($read_type_cond.read_type) == "single":
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
26 ln -s '${read1}' '${read1_identifier}' &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
27 #if $read1.is_of_type('fastqsanger.gz'):
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
28 #set gzipped = 'true'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
29 #end if
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
30 #else:
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
31 #set read2 = $read_type_cond.read2
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
32 #set read2_identifier = re.sub('[^\s\w\-]', '_', str($read2.element_identifier))
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
33 ln -s '${read1}' '${read1_identifier}' &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
34 ln -s '${read2}' '${read2_identifier}' &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
35 #if $read1.is_of_type('fastqsanger.gz') and $read2.is_of_type('fastqsanger.gz'):
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
36 #set gzipped = 'true'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
37 #end if
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
38 #end if
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
39 #set dbkey = $input_type_cond.vsnp_azc.metadata.dbkey
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
40 #else:
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
41 #for $i in $input_type_cond.reads_collection:
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
42 #if $i.is_of_type('fastqsanger.gz'):
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
43 #set gzipped = 'true'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
44 #end if
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
45 #set filename = $i.file_name
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
46 #set identifier = re.sub('[^\s\w\-]', '_', str($i.element_identifier))
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
47 ln -s $filename $input_reads_dir/$identifier &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
48 #end for
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
49 #for $i in $input_type_cond.samtools_idxstats_collection:
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
50 #set filename = $i.file_name
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
51 #set identifier = re.sub('[^\s\w\-]', '_', str($i.element_identifier))
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
52 ln -s $filename $input_idxstats_dir/$identifier &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
53 #end for
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
54 #for $i in $input_type_cond.azc_metrics_collection:
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
55 #set dbkey = $i.metadata.dbkey
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
56 #set filename = $i.file_name
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
57 #set identifier = re.sub('[^\s\w\-]', '_', str($i.element_identifier))
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
58 ln -s $filename $input_metrics_dir/$identifier &&
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
59 #end for
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
60 #end if
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
61 python '$__tool_directory__/vsnp_statistics.py'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
62 --processes $processes
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
63 --dbkey '$dbkey'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
64 --gzipped '$gzipped'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
65 #if str($input_type) == "single":
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
66 #if str($read_type_cond.read_type) == "single":
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
67 --read1 '${read1_identifier}'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
68 #else:
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
69 --read1 '${read1_identifier}'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
70 --read2 '${read2_identifier}'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
71 #end if
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
72 --samtools_idxstats '$samtools_idxstats'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
73 --vsnp_azc '$vsnp_azc'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
74 --output '$output'
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
75 #end if
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
76 ]]></command>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
77 <inputs>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
78 <conditional name="input_type_cond">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
79 <param name="input_type" type="select" label="Choose the category of the files to be analyzed">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
80 <option value="single" selected="true">Single files</option>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
81 <option value="collection">Collections of files</option>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
82 </param>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
83 <when value="single">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
84 <conditional name="read_type_cond">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
85 <param name="read_type" type="select" label="Choose the read type">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
86 <option value="paired" selected="true">Paired</option>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
87 <option value="single">Single</option>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
88 </param>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
89 <when value="paired">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
90 <param name="read1" type="data" format="fastqsanger.gz,fastqsanger" label="Read1 fastq file"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
91 <param name="read2" type="data" format="fastqsanger.gz,fastqsanger" label="Read2 fastq file"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
92 </when>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
93 <when value="single">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
94 <param name="read1" type="data" format="fastqsanger.gz,fastqsanger" label="Read1 fastq file"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
95 </when>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
96 </conditional>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
97 <param name="samtools_idxstats" type="data" format="tabular" label="Samtools idxstats file">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
98 <validator type="unspecified_build"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
99 </param>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
100 <param name="vsnp_azc" type="data" format="tabular" label="vSNP zero coverage metrics file">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
101 <validator type="unspecified_build"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
102 </param>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
103 </when>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
104 <when value="collection">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
105 <param name="reads_collection" type="data_collection" format="fastqsanger,fastqsanger.gz" collection_type="list" label="Collection of fastqsanger files"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
106 <param name="samtools_idxstats_collection" type="data_collection" format="tabular" collection_type="list" label="Collection of samtools idxstats files"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
107 <param name="azc_metrics_collection" type="data_collection" format="tabular" collection_type="list" label="Collection of vSNP zero-coverage metrics files"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
108 </when>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
109 </conditional>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
110 <param name="processes" type="integer" min="1" max="20" value="8" label="Number of processes for job splitting"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
111 </inputs>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
112 <outputs>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
113 <data name="output" format="tabular">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
114 <filter>input_type_cond['input_type'] == 'single'</filter>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
115 </data>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
116 <collection name="output_collection" type="list">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
117 <discover_datasets pattern="__name__" directory="output" format="tabular" />
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
118 <filter>input_type_cond['input_type'] == 'collection'</filter>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
119 </collection>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
120 </outputs>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
121 <tests>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
122 <test>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
123 <param name="read1" value="13-1941-6_S4_L001_R1_600000.fastq.gz" ftype="fastqsanger.gz" dbkey="89"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
124 <param name="read2" value="13-1941-6_S4_L001_R2_600000.fastq.gz" ftype="fastqsanger.gz" dbkey="89"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
125 <param name="samtools_idxstats" value="samtools_idxstats.tabular" ftype="tabular" dbkey="89"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
126 <param name="vsnp_azc" value="add_zc_metrics.tabular" ftype="tabular" dbkey="89"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
127 <output name="output" file="vsnp_statistics.tabular" ftype="tabular" compare="contains"/>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
128 </test>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
129 </tests>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
130 <help>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
131 **What it does**
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
132
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
133 Accepts a single fastqsanger read, a set of paired reads, or a collections of reads along with associated SAMtools
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
134 idxstats and vSNP zero coverage metrics files and extracts information from the files to produce a tabular statistics
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
135 dataset that includes total reads, mean read length and quality, reads passing Q30, mapped and unmapped reads, depth
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
136 of coverage, good SNP count and more.
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
137
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
138 **Required options**
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
139
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
140 * **Choose the type for files to be analyzed** - select "Single files" or "Collections of files", then select the appropriate history items (single or paired fastqsanger reads or collections of fastqsanger reads and associated idxstats and vSNP zero coverage metrics files) based on the selected option..
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
141 * **Number of processes for job splitting** - Select the number of processes for splitting the job to shorten execution time.
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
142 </help>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
143 <citations>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
144 <citation type="bibtex">
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
145 @misc{None,
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
146 journal = {None},
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
147 author = {1. Stuber T},
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
148 title = {Manuscript in preparation},
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
149 year = {None},
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
150 url = {https://github.com/USDA-VS/vSNP},}
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
151 </citation>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
152 </citations>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
153 </tool>
c21d338dbdc4 Uploaded
greg
parents:
diff changeset
154