Mercurial > repos > q2d2 > qiime2__rescript__extract_seq_segments
annotate qiime2__rescript__extract_seq_segments.xml @ 0:bb971260ea07 draft
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
author | q2d2 |
---|---|
date | Thu, 25 Apr 2024 21:20:02 +0000 |
parents | |
children | 555ba9f92313 |
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 <!-- |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
3 Copyright (c) 2024, QIIME 2 development team. |
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: |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
9 q2galaxy (version: 2024.2.1) |
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: |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
11 qiime2 (version: 2024.2.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 --> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
13 <tool name="qiime2 rescript extract-seq-segments" id="qiime2__rescript__extract_seq_segments" version="2024.2.2+q2galaxy.2024.2.1" profile="22.05" license="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
|
14 <description>Use reference sequences to extract shorter matching sequence segments from longer sequences based on a user-defined 'perc-identity' value.</description> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
15 <requirements> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
16 <container type="docker">quay.io/qiime2/amplicon:2024.2</container> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
17 </requirements> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
18 <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
|
19 <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
|
20 <configfiles> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
21 <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
|
22 </configfiles> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
23 <inputs> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
24 <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
|
25 <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
|
26 <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
|
27 </options> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
28 <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
|
29 </param> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
30 <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 'sequences'."> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
31 <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
|
32 <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
|
33 </options> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
34 <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
|
35 </param> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
36 <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
|
37 <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."/> |
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 name="min_seq_len" type="integer" min="1" optional="true" label="min_seq_len: Int % Range(1, None)" help="[optional] Minimum length of sequence allowed for searching. Any sequence less than this will be discarded. If not set, default program settings will be used."/> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
39 <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
|
40 </section> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
41 </inputs> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
42 <outputs> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
43 <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
|
44 <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
|
45 </outputs> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
46 <tests/> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
47 <help> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
48 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
|
49 ====================================== |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
50 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
|
51 |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
52 |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
53 Outputs: |
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 :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
|
56 :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
|
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 | |
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 Description: |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
61 ------------ |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
62 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
|
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 | |
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 </help> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
68 <citations> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
69 <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
|
70 <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
|
71 <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
|
72 </citations> |
bb971260ea07
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__rescript commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents:
diff
changeset
|
73 </tool> |