annotate data_manager/fetch_refseq.xml @ 7:efdead58e937 draft

planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit b682adad2c3c74567d23e1a5cf2bfcc3df1c96ae-dirty
author sanbi-uwc
date Fri, 07 Sep 2018 19:47:52 -0400
parents 7226cda27b03
children 97bf61f2fdae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
efdead58e937 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit b682adad2c3c74567d23e1a5cf2bfcc3df1c96ae-dirty
sanbi-uwc
parents: 6
diff changeset
1 <tool id="data_manager_fetch_refseq" name="RefSeq data manager" version="0.0.8" tool_type="manage_data">
0
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
2 <description>Fetch FASTA data from NCBI RefSeq and update all_fasta data table</description>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
3 <requirements>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
4 <requirement type="package" version="3">python</requirement>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
5 </requirements>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
6 <command detect_errors="aggressive"><![CDATA[
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
7 python3 $__tool_directory__/fetch_refseq.py
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
8 #if str( $advanced.advanced_selector ) == 'advanced':
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
9 '${advanced.compress}'
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
10 #end if
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
11 --galaxy_datamanager_filename '${output_file}'
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
12 --division_names ${division_names}
1
300562c726cc planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit a0125981706495e0a8be4fafe2eb1af3f0cfdaa3
sanbi-uwc
parents: 0
diff changeset
13 --mol_types ${mol_types}
0
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
14 #if str( $pin_date ) != 'NO':
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
15 --pin_date '${pin_date}'
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
16 #end if
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
17 ]]></command>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
18 <inputs>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
19 <param argument="division_names" type="select" label="RefSeq division" multiple="true">
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
20 <option value="archea">Archea</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
21 <option value="bacteria">Bacteria</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
22 <option value="complete">Complete</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
23 <option value="fungi">Fungi</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
24 <option value="invertebrate">Invertebrate</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
25 <option value="mitochondrion">Mitochondrion</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
26 <option value="other">Other</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
27 <option value="plant">Plant</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
28 <option value="plasmid">Plasmid</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
29 <option value="plastid">Plastid</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
30 <option value="protozoa">Protozoa</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
31 <option value="vertebrate_mammalian">Mammalian Vertebrate</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
32 <option value="vertebrate_other">Other Vertebrate</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
33 <option value="viral">Viral</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
34 </param>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
35 <param argument="mol_types" type="select" label="Molecule type" help="Select at least one of genomic, protein or rna sequence">
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
36 <option value="protein">Protein</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
37 <option value="genomic">Genomic (DNA)</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
38 <option value="rna">RNA</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
39 </param>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
40 <conditional name="advanced">
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
41 <param name="advanced_selector" type="select" label="Advanced Options">
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
42 <option value="basic" selected="True">Basic</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
43 <option value="advanced">Advanced</option>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
44 </param>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
45 <when value="basic">
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
46 </when>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
47 <when value="advanced">
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
48 <param type="boolean" argument="--compress" truevalue="--compress" falsevalue="" label="Compress FASTA files"
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
49 help="Compress downloaded FASTA files (with gzip). Limits compatibility with tools expecting uncompressed FASTA."/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
50 </when>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
51 </conditional>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
52 <param argument="--pin_date" type="hidden" value="NO" help="Used for testing"/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
53 </inputs>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
54 <outputs>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
55 <data name="output_file" format="data_manager_json"/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
56 </outputs>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
57 <tests>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
58 <test>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
59 <param name="division_names" value="plastid"/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
60 <param name="mol_types" value="protein"/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
61 <param name="pin_date" value="2018-03-14"/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
62 <param name="advanced_selector" value="basic"/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
63 <output name="output_file">
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
64 <assert_contents>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
65 <has_text text="2018-03-14"/>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
66 </assert_contents>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
67 </output>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
68 </test>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
69 </tests>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
70 <help><![CDATA[
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
71 This data manager fetches FASTA format collections of proteins, nucleotides (genomic DNA) and RNA
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
72 from NCBI's RefSeq_ data collection.
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
73
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
74 RefSeq is released every two months and consists of a number of divisions. Some sequences are shared
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
75 between multiple divisions. This data manager allows the Galaxy administrator to select which
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
76 divisions and which molecule types within each division to download. Once downloaded the
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
77 files are made accessible by adding an entry into the *all_fasta* data table.
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
78
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
79 .. _RefSeq: https://www.ncbi.nlm.nih.gov/refseq/
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
80 ]]>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
81 </help>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
82 <citations>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
83 <citation type="doi">10.1093/nar/gkv1189</citation>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
84 </citations>
cfe6cd521835 planemo upload for repository https://github.com/pvanheus/refseq_fasta_data_manager commit cfd2aa18826b938402ccfc6003f1793886001202-dirty
sanbi-uwc
parents:
diff changeset
85 </tool>