annotate ngs-tools_sample.xml @ 0:857d8fbe0cf7 draft

Uploaded
author cjav
date Wed, 09 Oct 2013 16:07:06 -0400
parents
children 533b8e35800d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
1 <tool id="ngs-tools_sample" name="Sample (ngs-tools)" version="1.0.0">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
2 <description></description>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
3 <requirements>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
4 <requirement type="package" version="0.1.7">ngs-tools</requirement>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
5 </requirements>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
6 <command>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
7 ngs-tools sample
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
8 --input-format $input_format.format
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
9 --sample-size $size
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
10 --output $output_file
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
11 #if str($input_format.paired.paired_selector) == "True"
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
12 --output-pair $output_file_pair
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
13 #end if
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
14 $input_format.paired.input_file
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
15 #if str($input_format.paired.paired_selector) == "True"
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
16 $input_format.paired.input_file_pair
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
17 #end if
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
18 </command>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
19 <inputs>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
20 <conditional name="input_format">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
21 <param name="format" type="select" label="Input format">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
22 <option value="fastq" selected="true">Fastq</option>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
23 </param>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
24 <when value="fastq">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
25 <conditional name="paired">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
26 <param name="paired_selector" type="select" label="Paired data?">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
27 <option value="True">Yes</option>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
28 <option value="False" selected="true">No</option>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
29 </param>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
30 <when value="True">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
31 <param name="input_file" type="data" format="fastq" label="FASTQ File to sample from" />
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
32 <param name="input_file_pair" type="data" format="fastq" label="FASTQ Paired File to sample from" />
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
33 </when>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
34 <when value="False">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
35 <param name="input_file" type="data" format="fastq" label="FASTQ File to sample from" />
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
36 </when>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
37 </conditional>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
38 </when>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
39 </conditional>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
40 <param name="size" type="integer" size="6" value="100" label="Number of records to sample" />
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
41 </inputs>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
42 <outputs>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
43 <data name="output_file" format="input" />
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
44 <data name="output_file_pair" format="input">
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
45 <filter>input_format['paired']['paired_selector'] == "True"</filter>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
46 </data>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
47 </outputs>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
48 <help>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
49
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
50 **What it does**
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
51
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
52 This tool samples a random number of records from the input file(s). Supports
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
53 paired data assuming paired files are in sync.
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
54
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
55 Supported formats: FASTQ.
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
56
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
57 --------
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
58
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
59 This tool is based on `ngs-tools`__ by Carlos Borroto &lt;carlos.borroto@gmail.com&gt;.
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
60
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
61 .. __: https://github.com/cjav/ngs-tools/
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
62
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
63 </help>
857d8fbe0cf7 Uploaded
cjav
parents:
diff changeset
64 </tool>