Mercurial > repos > peterjc > sff_filter_by_id
annotate tools/filters/sff_filter_by_id.xml @ 0:eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
author | peterjc |
---|---|
date | Tue, 07 Jun 2011 17:24:49 -0400 |
parents | |
children | 9cd3591f6afa |
rev | line source |
---|---|
0
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
1 <tool id="sff_filter_by_id" name="Filter SFF by ID" version="0.0.1"> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
2 <description>from a tabular file</description> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
3 <command interpreter="python"> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
4 sff_filter_by_id.py $input_tabular $columns $input_sff |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
5 #if $output_choice_cond.output_choice=="both" |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
6 $output_pos $output_neg |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
7 #elif $output_choice_cond.output_choice=="pos" |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
8 $output_pos - |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
9 #elif $output_choice_cond.output_choice=="neg" |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
10 - $output_neg |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
11 #end if |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
12 </command> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
13 <inputs> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
14 <param name="input_sff" type="data" format="sff" label="SFF file to filter on the identifiers"/> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
15 <param name="input_tabular" type="data" format="tabular" label="Tabular file containing SFF identifiers"/> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
16 <param name="columns" type="data_column" data_ref="input_tabular" multiple="True" numerical="False" label="Column(s) containing SFF identifiers" help="Multi-select list - hold the appropriate key while clicking to select multiple columns"> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
17 <validator type="no_options" message="Pick at least one column"/> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
18 </param> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
19 <conditional name="output_choice_cond"> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
20 <param name="output_choice" type="select" label="Output positive matches, negative matches, or both?"> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
21 <option value="both">Both positive matches (ID on list) and negative matches (ID not on list), as two SFF files</option> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
22 <option value="pos">Just positive matches (ID on list), as a single SFF file</option> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
23 <option value="neg">Just negative matches (ID not on list), as a single SFF file</option> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
24 </param> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
25 <!-- Seems need these dummy entries here, compare this to indels/indel_sam2interval.xml --> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
26 <when value="both" /> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
27 <when value="pos" /> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
28 <when value="neg" /> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
29 </conditional> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
30 </inputs> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
31 <outputs> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
32 <data name="output_pos" format="sff" label="With matched ID"> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
33 <filter>output_choice_cond["output_choice"] != "neg"</filter> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
34 </data> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
35 <data name="output_neg" format="sff" label="Without matched ID"> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
36 <filter>output_choice_cond["output_choice"] != "pos"</filter> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
37 </data> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
38 </outputs> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
39 <tests> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
40 </tests> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
41 <requirements> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
42 <requirement type="python-module">Bio</requirement> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
43 </requirements> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
44 <help> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
45 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
46 **What it does** |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
47 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
48 By default it divides a Standard Flowgram Format (SFF) file in two, those |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
49 sequences with or without an ID present in the tabular file column(s) specified. |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
50 You can opt to have a single output file of just the matching records, or just |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
51 the non-matching ones. |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
52 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
53 Note that the order of sequences in the original SFF file is preserved, as is |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
54 any Roche XML Manifest. Also, if any sequences share an identifier (which would |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
55 be very unusual in SFF files, duplicates are not removed). |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
56 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
57 **Example Usage** |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
58 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
59 You may have performed some kind of contamination search, for example running |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
60 BLASTN against a database of cloning vectors or bacteria, giving you a tabular |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
61 file containing read identifiers. You could use this tool to extract only the |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
62 reads without BLAST matches (i.e. those which do not match your contaminant |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
63 database). |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
64 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
65 ** Citation ** |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
66 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
67 This tool uses Biopython to read and write SFF files. If you use this tool in |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
68 scientific work leading to a publication, please cite the Biopython application |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
69 note: |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
70 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
71 Cock et al 2009. Biopython: freely available Python tools for computational |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
72 molecular biology and bioinformatics. Bioinformatics 25(11) 1422-3. |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
73 http://dx.doi.org/10.1093/bioinformatics/btp163 pmid:19304878. |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
74 |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
75 </help> |
eb852527b26c
Migrated tool version 0.0.1 from old tool shed archive to new tool shed repository
peterjc
parents:
diff
changeset
|
76 </tool> |