annotate tool-data/blastdb_p.loc.sample @ 2:b1dc6ed2cc07 draft default tip

planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 9a14ed1f2d3c9abdfb080251b3419dd9e0c52a14
author galaxyp
date Tue, 08 Aug 2017 12:54:47 -0400
parents e3ee9f1693c3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
1 #NOTE: This file comes from the tool galaxyp/blast_plus_remote_blastp
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
2 # This is a sample file distributed with Galaxy that is used to define a
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
3 # list of protein BLAST databases, using three columns tab separated:
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
4 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
5 # <unique_id>{tab}<database_caption>{tab}<base_name_path>
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
6 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
7 # The captions typically contain spaces and might end with the build date.
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
8 # It is important that the actual database name does not have a space in
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
9 # it, and that there are only two tabs on each line.
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
10 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
11 # You can download the NCBI provided protein databases like NR from here:
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
12 # ftp://ftp.ncbi.nlm.nih.gov/blast/db/
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
13 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
14 # For simplicity, many Galaxy servers are configured to offer just a live
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
15 # version of each NCBI BLAST database (updated with the NCBI provided
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
16 # Perl scripts or similar). In this case, we recommend using the case
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
17 # sensistive base-name of the NCBI BLAST databases as the unique id.
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
18 # Consistent naming is important for sharing workflows between Galaxy
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
19 # servers.
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
20 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
21 # For example, consider the NCBI "non-redundant" protein BLAST database
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
22 # where you have downloaded and decompressed the files under /data/blastdb/
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
23 # meaning at the command line BLAST+ would be run with something like
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
24 # which would look at the files /data/blastdb/nr.p*:
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
25 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
26 # $ blastp -db /data/blastdb/nr -query ...
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
27 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
28 # In this case use nr (lower case to match the NCBI file naming) as the
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
29 # unique id in the first column of blastdb_p.loc, giving an entry like
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
30 # this:
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
31 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
32 # nr{tab}NCBI non-redundant (nr){tab}/data/blastdb/nr
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
33 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
34 # Alternatively, rather than a "live" mirror of the NCBI databases which
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
35 # are updated automatically, for full reproducibility the Galaxy Team
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
36 # recommend saving date-stamped copies of the databases. In this case
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
37 # your blastdb_p.loc file should include an entry per line for each
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
38 # version you have stored. For example:
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
39 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
40 # nr_05Jun2010{tab}NCBI NR (non redundant) 05 Jun 2010{tab}/data/blastdb/05Jun2010/nr
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
41 # nr_15Aug2010{tab}NCBI NR (non redundant) 15 Aug 2010{tab}/data/blastdb/15Aug2010/nr
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
42 # ...etc...
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
43 #
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
44 # See also blastdb.loc which is for any nucleotide BLAST database, and
e3ee9f1693c3 planemo upload for repository https://github.com/peterjc/galaxy_blast/tree/master/tools/ncbi_blast_plus commit 8cb8939dadaad8e804e35128cfb7b2560eb4d9b4
galaxyp
parents:
diff changeset
45 # blastdb_d.loc which is for any protein domains databases (like CDD).