annotate fastaptamer_count_1.xml @ 0:2bed8ca187a1 draft

Uploaded
author fastaptamer
date Tue, 10 Feb 2015 14:22:39 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
1 <tool id="fastaptamer_count_1_0_2" name="FASTAptamer-Count" version="1.0.2">
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
2
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
3 <description>Count, rank, sort and normalize sequence reads in a selection population.</description>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
4
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
5 <version_command>fastaptamer_count -v</version_command>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
6
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
7 <command interpreter="perl">fastaptamer_count -i $input -o $output</command>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
8
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
9 <inputs>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
10 <param name="input" type="data" format="fastq" label="Input file" help="Must be FASTQ and should be pre-processed (filtered for quality and trimmed of constant regions)."></param>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
11 </inputs>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
12
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
13 <outputs>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
14 <data name="output" format="fasta" label="FASTAptamer-Count output file"></data>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
15 </outputs>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
16
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
17 <help>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
18
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
19 .. class:: warningmark
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
20
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
21 FASTAptamer-Count requires FASTQ formatted input files.
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
22
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
23 .. class:: infomark
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
24
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
25 Input files should be trimmed of constant regions and filtered for only high-quality reads.
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
26
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
27 ------
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
28
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
29 **FASTAptamer-Count** serves as the gateway to the FASTAptamer suite of bioinformatics tools for combinatorial selections.
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
30
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
31 For a given FASTQ input file, FASTAptamer-Count will determine the number of times each sequence was read, normalize sequence frequency to reads per million, and rank and sort sequences by decreasing total reads.
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
32
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
33 Output is generated as a sorted and non-redundant FASTA formatted file in which each unique sequence generates a FASTA entry with the following information in the description line:
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
34
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
35 >RANK-READS-RPM
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
36
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
37 RANK is the relative abundance of the sequence within the population. In cases where two or more sequences are sampled with equal abundance, FASTAptamer-Count follows standard competition ranking (e.g., “1-2-2-4” where two sequences are tied for second). READS is the raw number of times a sequence was counted. RPM is “Reads per million,” which is a normalized value that allows for comparison across populations of varying read depth. RPM is calculated as: RPM = (READS/(population size)) x 10^6.
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
38
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
39 ------
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
40
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
41 .. image::
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
42 http://burkelab.missouri.edu/images/fastaptamer-logo-xs.png
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
43 :height: 98
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
44 :width: 300
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
45
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
46 For more information on FASTAptamer, visit our website_.
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
47
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
48 FASTAptamer is distributed under a GNU GPL v3.0 license. For complete license click here_.
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
49
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
50 .. _here: http://burkelab.missouri.edu/fastaptamer/LICENSE.txt
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
51 .. _website: http://burkelab.missouri.edu/fastaptamer.html
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
52
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
53 </help>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
54
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
55 <citations>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
56 <citation type="doi">doi:10.1038/mtna.2015.4</citation>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
57 </citations>
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
58
2bed8ca187a1 Uploaded
fastaptamer
parents:
diff changeset
59 </tool>