annotate tool-data/blastdb.loc.sample @ 3:ce86aafd8494 draft

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