annotate fastaptamer_count_1.xml @ 1:350a7a33158a draft default tip

Uploaded
author fastaptamer
date Wed, 14 Jan 2015 19:01:45 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
1 <tool id="fastaptamer_count_1_0_1" name="FASTAptamer-Count" version="1.0.1">
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
2
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
3 <description>Count, rank, sort and normalize sequence reads in a selection population.</description>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
4
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
5 <version_command>fastaptamer_count -v</version_command>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
6
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
7 <command interpreter="perl">fastaptamer_count -i $input -o $output</command>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
8
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
9 <inputs>
350a7a33158a 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>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
11 </inputs>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
12
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
13 <outputs>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
14 <data name="output" format="fasta" label="FASTAptamer-Count output file"></data>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
15 </outputs>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
16
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
17 <help>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
18
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
19 .. class:: warningmark
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
20
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
21 FASTAptamer-Count requires FASTQ formatted input files.
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
22
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
23 .. class:: infomark
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
24
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
25 Input files should be trimmed of constant regions and filtered for only high-quality reads.
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
26
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
27 ------
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
28
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
29 **FASTAptamer-Count** serves as the gateway to the FASTAptamer suite of bioinformatics tools for combinatorial selections.
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
30
350a7a33158a 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.
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
32
350a7a33158a 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:
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
34
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
35 >RANK-READS-RPM
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
36
350a7a33158a 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.
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
38
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
39 ------
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
40
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
41 .. image::
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
42 http://burkelab.missouri.edu/images/fastaptamer-logo-xs.png
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
43 :height: 98
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
44 :width: 300
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
45
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
46 For more information on FASTAptamer, visit our website_.
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
47
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
48 FASTAptamer is distributed under a GNU GPL v3.0 license. For complete license click here_.
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
49
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
50 .. _here: http://burkelab.missouri.edu/fastaptamer/LICENSE.txt
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
51 .. _website: http://burkelab.missouri.edu/fastaptamer.html
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
52
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
53 </help>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
54
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
55 <citations>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
56 <citation type="doi">doi:10.1038/mtna.2015.7x</citation>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
57 </citations>
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
58
350a7a33158a Uploaded
fastaptamer
parents:
diff changeset
59 </tool>