Mercurial > repos > q2d2 > qiime2__rescript__extract_seq_segments

annotate qiime2__rescript__extract_seq_segments.xml @ 3:80a749825bfd 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/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
author q2d2
date Mon, 05 May 2025 19:03:09 +0000
parents 8d441435b9e6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
2 <!--
3
80a749825bfd planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 2
diff changeset
3 Copyright (c) 2025, QIIME 2 development team.
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
4
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
6 -->
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
7 <!--
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
8 This tool was automatically generated by:
3
80a749825bfd planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 2
diff changeset
9 q2galaxy (version: 2025.4.0)
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
10 for:
3
80a749825bfd planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 2
diff changeset
11 qiime2 (version: 2025.4.0)
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
12 -->
3
80a749825bfd planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 2
diff changeset
13 <tool name="qiime2 rescript extract-seq-segments" id="qiime2__rescript__extract_seq_segments" version="2025.4.0+q2galaxy.2025.4.0" profile="22.05" license="BSD-3-Clause">
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
14 <description>Use reference sequences to extract shorter matching sequence segments from longer sequences based on a user-defined 'perc-identity' value.</description>
2
8d441435b9e6 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 1
diff changeset
15 <xrefs>
8d441435b9e6 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 1
diff changeset
16 <xref type="bio.tools">qiime2</xref>
8d441435b9e6 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 1
diff changeset
17 </xrefs>
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
18 <requirements>
3
80a749825bfd planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 2
diff changeset
19 <container type="docker">quay.io/qiime2/amplicon:2025.4</container>
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
20 </requirements>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
21 <version_command>q2galaxy version rescript</version_command>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
22 <command detect_errors="exit_code">q2galaxy run rescript extract_seq_segments '$inputs'</command>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
23 <configfiles>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
24 <inputs name="inputs" data_style="staging_path_and_source_path"/>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
25 </configfiles>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
26 <inputs>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
27 <param name="input_sequences" type="data" format="qza" label="input_sequences: FeatureData[Sequence]" help="[required] Sequences from which matching shorter sequence segments (regions) can be extracted from. Sequences containing segments that match those from 'reference-segment-sequences' will have those segments extracted and written to file.">
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
28 <options options_filter_attribute="metadata.semantic_type">
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
29 <filter type="add_value" value="FeatureData[Sequence]"/>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
30 </options>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
31 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureData[Sequence]']</validator>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
32 </param>
2
8d441435b9e6 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 1
diff changeset
33 <param name="reference_segment_sequences" type="data" format="qza" label="reference_segment_sequences: FeatureData[Sequence]" help="[required] Reference sequence segments that will be used to search for and extract matching segments from 'input-sequences'.">
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
34 <options options_filter_attribute="metadata.semantic_type">
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
35 <filter type="add_value" value="FeatureData[Sequence]"/>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
36 </options>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
37 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureData[Sequence]']</validator>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
38 </param>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
39 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
40 <param name="perc_identity" type="float" min="1e-06" max="1" value="0.7" label="perc_identity: Float % Range(0, 1, inclusive_start=False, inclusive_end=True)" help="[default: 0.7] The percent identity at which clustering should be performed. This parameter maps to vsearch's --id parameter."/>
2
8d441435b9e6 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 1
diff changeset
41 <param name="target_coverage" type="float" min="1e-06" max="1" value="0.9" label="target_coverage: Float % Range(0, 1, inclusive_start=False, inclusive_end=True)" help="[default: 0.9] The minimum fraction of coverage that 'reference-segment-sequences' must have in order to extract matching segments from 'input-sequences'."/>
3
80a749825bfd planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 2
diff changeset
42 <param name="min_seq_len" type="integer" min="1" value="32" label="min_seq_len: Int % Range(1, None)" help="[default: 32] Minimum length of reference sequence segment allowed for searching. Any sequence less than this will be discarded."/>
80a749825bfd planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 2
diff changeset
43 <param name="max_seq_len" type="integer" min="1" value="50000" label="max_seq_len: Int % Range(1, None)" help="[default: 50000] Maximum length of reference sequence segment allowed for searching. Any sequence greater than this will be discarded."/>
0
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
44 <param name="threads" type="integer" min="1" max="255" value="1" label="threads: Int % Range(1, 256)" help="[default: 1] Number of computation threads to use (1 to 256). The number of threads should be lesser or equal to the number of available CPU cores."/>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
45 </section>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
46 </inputs>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
47 <outputs>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
48 <data name="extracted_sequence_segments" format="qza" label="${tool.name} on ${on_string}: extracted_sequence_segments.qza" from_work_dir="extracted_sequence_segments.qza"/>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
49 <data name="unmatched_sequences" format="qza" label="${tool.name} on ${on_string}: unmatched_sequences.qza" from_work_dir="unmatched_sequences.qza"/>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
50 </outputs>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
51 <tests/>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
52 <help>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
53 QIIME 2: rescript extract-seq-segments
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
54 ======================================
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
55 Use reference sequences to extract shorter matching sequence segments from longer sequences based on a user-defined 'perc-identity' value.
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
56
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
57
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
58 Outputs:
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
59 --------
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
60 :extracted_sequence_segments.qza: Extracted sequence segments from 'input-sequences' that succesfully aligned to 'reference-segment-sequences'.
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
61 :unmatched_sequences.qza: Sequences in 'input-sequences' that did not have matching sequence segments within 'reference-segment-sequences'.
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
62
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
63 |
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
64
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
65 Description:
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
66 ------------
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
67 This action provides the ability to extract a region, or segment, of sequence without the need to specify primer pairs. This is very useful in cases when one or more of the primer sequences are not present within the target sequences, which prevents extraction of the (amplicon) region through primer-pair searching. Here, VSEARCH is used to extract these segments based on a reference pool of sequences that only span the region of interest.
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
68
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
69
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
70 |
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
71
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
72 </help>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
73 <citations>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
74 <citation type="doi">10.7717/peerj.2584</citation>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
75 <citation type="doi">10.1371/journal.pcbi.1009581</citation>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
76 <citation type="doi">10.1038/s41587-019-0209-9</citation>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
77 </citations>
bb971260ea07 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff changeset
78 </tool>