Mercurial > repos > iuc > data_manager_build_bracken_database

annotate data_manager/bracken_build_database.xml @ 6:84cc0dc92b0c draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
author iuc
date Wed, 06 Mar 2024 14:09:08 +0000
parents 5c8a23ccb14a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
5
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
2 <tool id="bracken_build_database" name="Bracken Database Builder" tool_type="manage_data" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
3 <description>bracken database builder</description>
5
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
4 <macros>
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
5 <token name="@TOOL_VERSION@">2.8</token>
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
6 <token name="@VERSION_SUFFIX@">0</token>
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
7 <token name="@PROFILE@">22.01</token>
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
8 </macros>
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
9 <requirements>
5
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
10 <requirement type="package" version="@TOOL_VERSION@">bracken</requirement>
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
11 </requirements>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
12 <command>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
13 <![CDATA[
1
9059edc96a85 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 2e8d990fa8b6de085046195464071020b467ce5a"
iuc
parents: 0
diff changeset
14 #import os
9059edc96a85 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 2e8d990fa8b6de085046195464071020b467ce5a"
iuc
parents: 0
diff changeset
15 #set db_dir = os.path.basename($kraken_db.fields.path)
9059edc96a85 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 2e8d990fa8b6de085046195464071020b467ce5a"
iuc
parents: 0
diff changeset
16
9059edc96a85 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 2e8d990fa8b6de085046195464071020b467ce5a"
iuc
parents: 0
diff changeset
17 mkdir '$db_dir' &&
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
18 ln -s '${kraken_db.fields.path}/*' '$db_dir/' &&
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
19 python '$__tool_directory__/bracken_build_database.py'
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
20 '${out_file}'
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
21
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
22 --threads \${GALAXY_SLOTS:-1}
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
23 #if $check_prebuilt.prebuilt == "no"
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
24 --kraken-db '$db_dir'
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
25 --kmer-len ${check_prebuilt.kmer_len}
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
26 #end if
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
27 #if $check_prebuilt.prebuilt == "yes"
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
28 --kraken-db '${kraken_db.fields.path}'
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
29 --prebuilt
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
30 #end if
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
31 --read-len ${check_prebuilt.read_len}
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
32 --database-name '${database_name}'
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
33 ]]>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
34 </command>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
35 <inputs>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
36 <param name="kraken_db" type="select">
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
37 <options from_data_table="kraken2_databases">
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
38 <validator type="no_options" message="No Kraken2 databases are available" />
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
39 </options>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
40 </param>
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
41 <conditional name="check_prebuilt">
6
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
42 <param name="prebuilt" type="select" label="Use Pre-built DB" help="Use existing pre-built DB. This only works for kraken DBs, that already contain additional bracken DBs. This is the case for DBs downloaded from https://benlangmead.github.io/aws-indexes/k2.">
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
43 <option value="no">No</option>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
44 <option value="yes">Yes</option>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
45 </param>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
46 <when value="no">
6
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
47 <param name="kmer_len" type="integer" min="8" max="256" value="35" label="K-mer length" help="The K-mer length of the bracken DB should be identical to the K-mer length used to build the kraken2 DB." />
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
48 <param name="read_len" type="integer" min="8" max="1000" value="100" label="Read length" help="The read length of the bracken DB should be the same as the length of the reads to be analysis (one read in case of paired reads)." />
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
49 </when>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
50 <when value="yes">
6
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
51 <param name="read_len" type="select" label="Read length" help="The read length of the bracken DB should be the same as the length of the reads to be analysis (one read in case of paired reads). The prebuilt DBs where built using the same K-mer length as the kraken2 DB.">
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
52 <option value="50">50</option>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
53 <option value="75">75</option>
5
5c8a23ccb14a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit db62b99fe2c0e77e7ee63da5fb315f4b6d95170b
iuc
parents: 3
diff changeset
54 <option value="100" selected="true">100</option>
3
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
55 <option value="150">150</option>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
56 <option value="200">200</option>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
57 <option value="250">250</option>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
58 <option value="300">300</option>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
59 </param>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
60 </when>
3c7d2c84cb09 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 798f4c97da10258a9ab6c16903b169ce69a05523"
iuc
parents: 1
diff changeset
61 </conditional>
6
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
62 <param name="database_name" type="text" label="Database Name" help="Please add a clear reference to the corresponding kraken2 DB the read length to the name." />
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
63 </inputs>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
64 <outputs>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
65 <data name="out_file" format="data_manager_json" />
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
66 </outputs>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
67 <tests>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
68 <test>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
69 <param name="kraken_db" value="test_entry" />
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
70 <param name="database_name" value="database" />
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
71 <output name="out_file">
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
72 <assert_contents>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
73 <has_text text="test_db/database100mers.kmer_distrib" />
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
74 </assert_contents>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
75 </output>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
76 </test>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
77 </tests>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
78 <help>
6
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
79 A bracken DB can only be built as an addition to an existing kracken2 DB (see `Bracken docs`_).
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
80
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
81 .. _Bracken docs: https://github.com/jenniferlu717/Bracken?tab=readme-ov-file#step-1-generate-the-bracken-database-file-databasexmerskmer_distrib-1
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
82
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
83 ======================================
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
84 Using prebuilt DBs
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
85 ======================================
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
86
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
87 The prebuilt option does use existing bracken DBs, that are shipped with kraken2 DBs. This is the case for DBs downloaded from https://benlangmead.github.io/aws-indexes/k2.
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
88 All prebuilt databases contain a Kraken 2 database along with Bracken databases built for 50, 75, 100, 150, 200, 250 and 300 read lengths (refering to the lenght of the sequenced reads to be analysis using that database (one read in case of paired reads)).
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
89 In this case the data manager points to the same DB as the kracken2 DB.
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
90 **The prebuilt option must not be used for custom kraken2 DBs ! For this the bracken DB needs to be build.**
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
91
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
92 ======================================
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
93 Building new DBs
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
94 ======================================
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
95
84cc0dc92b0c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit c0f150357d52e21443197b2ec1427feb9fc7971e
iuc
parents: 5
diff changeset
96 Use the same K-mer length as the kraken2 DB and choose read lengths that are close to the read length of analysis you want to perform (one read in case of paired reads).
0
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
97 </help>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
98 <citations>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
99 <citation type="doi">10.7717/peerj-cs.104</citation>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
100 </citations>
c2e4127fb5bf "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_build_bracken_database/ commit 74e81c69c8806d98beb15a889741bcd702866ce3"
iuc
parents:
diff changeset
101 </tool>