view qiime2__rescript__get_silva_data.xml @ 1:e46b70a4eccd draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit c7e80dcda727ce63b42aa8a946e9330310929797

<?xml version='1.0' encoding='utf-8'?>
<!--
Copyright (c) 2024, QIIME 2 development team.

Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
-->
<!--
This tool was automatically generated by:
    q2galaxy (version: 2024.5.0)
for:
    qiime2 (version: 2024.5.0)
-->
<tool name="qiime2 rescript get-silva-data" id="qiime2__rescript__get_silva_data" version="2024.5.0+q2galaxy.2024.5.0" profile="22.05" license="BSD-3-Clause">
    <description>Download, parse, and import SILVA database.</description>
    <requirements>
        <container type="docker">quay.io/qiime2/amplicon:2024.5</container>
    </requirements>
    <version_command>q2galaxy version rescript</version_command>
    <command detect_errors="exit_code">q2galaxy run rescript get_silva_data '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="staging_path_and_source_path"/>
    </configfiles>
    <inputs>
        <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
            <param name="version" type="select" label="version: Str % Choices('128', '132')¹ | Str % Choices('138')² | Str % Choices('138.1')³" help="[default: '138.1']  SILVA database version to download.">
                <option value="128">128 (Str)</option>
                <option value="132">132 (Str)</option>
                <option value="138">138 (Str)</option>
                <option value="138.1" selected="true">138.1 (Str)</option>
            </param>
            <param name="target" type="select" label="target: Str % Choices('SSURef_NR99', 'SSURef', 'LSURef')¹ | Str % Choices('SSURef_NR99', 'SSURef')² | Str % Choices('SSURef_NR99', 'SSURef', 'LSURef_NR99', 'LSURef')³" help="[default: 'SSURef_NR99']  Reference sequence target to download. SSURef = redundant small subunit reference. LSURef = redundant large subunit reference. SSURef_NR99 = non-redundant (clustered at 99% similarity) small subunit reference.">
                <option value="SSURef_NR99" selected="true">SSURef_NR99 (Str)</option>
                <option value="SSURef">SSURef (Str)</option>
                <option value="LSURef">LSURef (Str)</option>
                <option value="LSURef_NR99">LSURef_NR99 (Str)</option>
            </param>
            <param name="include_species_labels" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="include_species_labels: Bool" help="[default: No]  Include species rank labels in taxonomy output. Note: species-labels may not be reliable in all cases."/>
            <param name="rank_propagation" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" checked="true" label="rank_propagation: Bool" help="[default: Yes]  If a rank has no taxonomy associated with it, the taxonomy from the upper-level rank of that lineage, will be propagated downward. For example, if we are missing the genus label for 'f__Pasteurellaceae; g__'then the 'f__' rank will be propagated to become: 'f__Pasteurellaceae; g__Pasteurellaceae'."/>
            <repeat name="ranks" help="[optional]  List of taxonomic ranks for building a taxonomy from the SILVA Taxonomy database. Use 'include_species_labels' to append the organism name as the species label. [default: 'domain', 'phylum', 'class', 'order', 'family', 'genus']" title="ranks: List[Str % Choices('domain', 'superkingdom', 'kingdom', 'subkingdom', 'superphylum', 'phylum', 'subphylum', 'infraphylum', 'superclass', 'class', 'subclass', 'infraclass', 'superorder', 'order', 'suborder', 'superfamily', 'family', 'subfamily', 'genus')]">
                <param name="element" type="select" label="element: Str % Choices('domain', 'superkingdom', 'kingdom', 'subkingdom', 'superphylum', 'phylum', 'subphylum', 'infraphylum', 'superclass', 'class', 'subclass', 'infraclass', 'superorder', 'order', 'suborder', 'superfamily', 'family', 'subfamily', 'genus')">
                    <option value="__q2galaxy__::literal::None">Selection required</option>
                    <option value="domain">domain</option>
                    <option value="superkingdom">superkingdom</option>
                    <option value="kingdom">kingdom</option>
                    <option value="subkingdom">subkingdom</option>
                    <option value="superphylum">superphylum</option>
                    <option value="phylum">phylum</option>
                    <option value="subphylum">subphylum</option>
                    <option value="infraphylum">infraphylum</option>
                    <option value="superclass">superclass</option>
                    <option value="class">class</option>
                    <option value="subclass">subclass</option>
                    <option value="infraclass">infraclass</option>
                    <option value="superorder">superorder</option>
                    <option value="order">order</option>
                    <option value="suborder">suborder</option>
                    <option value="superfamily">superfamily</option>
                    <option value="family">family</option>
                    <option value="subfamily">subfamily</option>
                    <option value="genus">genus</option>
                    <validator type="expression" message="Please verify this parameter.">value != '__q2galaxy__::literal::None'</validator>
                </param>
            </repeat>
            <param name="download_sequences" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" checked="true" label="download_sequences: Bool" help="[default: Yes]  Toggle whether or not to download and import the SILVA reference sequences associated with the release. Skipping the sequences is useful if you only want to download and parse the taxonomy, e.g., a local copy of the sequences already exists or for testing purposes. NOTE: if this option is used, a `silva_sequences` output is still created, but contains no data."/>
        </section>
    </inputs>
    <outputs>
        <data name="silva_sequences" format="qza" label="${tool.name} on ${on_string}: silva_sequences.qza" from_work_dir="silva_sequences.qza"/>
        <data name="silva_taxonomy" format="qza" label="${tool.name} on ${on_string}: silva_taxonomy.qza" from_work_dir="silva_taxonomy.qza"/>
    </outputs>
    <tests/>
    <help>
QIIME 2: rescript get-silva-data
================================
Download, parse, and import SILVA database.


Outputs:
--------
:silva_sequences.qza: SILVA reference sequences.
:silva_taxonomy.qza: SILVA reference taxonomy.

|  

Description:
------------
Download, parse, and import SILVA database files, given a version number and reference target. Downloads data directly from SILVA, parses the taxonomy files, and outputs ready-to-use sequence and taxonomy artifacts. REQUIRES STABLE INTERNET CONNECTION. NOTE: THIS ACTION ACQUIRES DATA FROM THE SILVA DATABASE. SEE https://www.arb-silva.de/silva-license-information/ FOR MORE INFORMATION and be aware that earlier versions may be released under a different license.


|  

</help>
    <citations>
        <citation type="bibtex">@article{cite1,
 author = {Pruesse, Elmar and Quast, Christian and Knittel, Katrin and Fuchs, Bernhard M and Ludwig, Wolfgang and Peplies, Jorg and Glockner, Frank Oliver},
 journal = {Nucleic Acids Res},
 number = {21},
 pages = {7188-7196},
 title = {SILVA: a comprehensive online resource for quality checked and aligned ribosomal RNA sequence data compatible with ARB},
 volume = {35},
 year = {2007}
}
</citation>
        <citation type="bibtex">@article{cite2,
 author = {Quast, Christian and Pruesse, Elmar and Yilmaz, Pelin and Gerken, Jan and Schweer, Timmy and Yarza, Pablo and Peplies, Jorg and Glockner, Frank Oliver},
 journal = {Nucleic Acids Res},
 number = {Database issue},
 pages = {D590-6},
 publisher = {Oxford University Press},
 title = {The SILVA ribosomal RNA gene database project: improved data processing and web-based tools},
 volume = {41},
 year = {2013}
}
</citation>
        <citation type="doi">10.1371/journal.pcbi.1009581</citation>
        <citation type="doi">10.1038/s41587-019-0209-9</citation>
    </citations>
</tool>