Mercurial > repos > q2d2 > qiime2__diversity__filter_distance_matrix
view qiime2__diversity__filter_distance_matrix.xml @ 2:a53b321e6821 draft
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 65e4952f33eb335528e8553150e9097e5ea8f556
author | q2d2 |
---|---|
date | Thu, 08 Jun 2023 19:36:52 +0000 |
parents | 40dc453ee8fd |
children | 6741643b2f7f |
line wrap: on
line source
<?xml version='1.0' encoding='utf-8'?> <!-- Copyright (c) 2023, 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: 2023.5.0) for: qiime2 (version: 2023.5.1) --> <tool name="qiime2 diversity filter-distance-matrix" id="qiime2__diversity__filter_distance_matrix" version="2023.5.1+q2galaxy.2023.5.0.2" profile="22.05" license="BSD-3-Clause"> <description>Filter samples from a distance matrix.</description> <requirements> <container type="docker">quay.io/qiime2/core:2023.5</container> </requirements> <version_command>q2galaxy version diversity</version_command> <command detect_errors="exit_code">q2galaxy run diversity filter_distance_matrix '$inputs'</command> <configfiles> <inputs name="inputs" data_style="paths"/> </configfiles> <inputs> <param name="distance_matrix" type="data" format="qza" label="distance_matrix: DistanceMatrix" help="[required] Distance matrix to filter by sample."> <options options_filter_attribute="metadata.semantic_type"> <filter type="add_value" value="DistanceMatrix"/> </options> <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['DistanceMatrix']</validator> </param> <repeat name="metadata" min="1" help="[required] Sample metadata used with `where` parameter when selecting samples to retain, or with `exclude_ids` when selecting samples to discard." title="metadata: Metadata"> <conditional name="__q2galaxy__GUI__conditional__metadata__"> <param name="type" type="select" label="metadata: Metadata"> <option value="tsv" selected="true">Metadata from TSV</option> <option value="qza">Metadata from Artifact</option> </param> <when value="tsv"> <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/> </when> <when value="qza"> <param name="source" type="data" format="qza" label="Metadata Source"/> </when> </conditional> </repeat> <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options"> <conditional name="__q2galaxy__GUI__conditional__where__" label="where: Str"> <param name="__q2galaxy__GUI__select__" type="select" label="where: Str" help="[optional] SQLite WHERE clause specifying sample metadata criteria that must be met to be included in the filtered distance matrix. If not provided, all samples in `metadata` that are also in the input distance matrix will be retained."> <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option> <option value="__q2galaxy__::control::provide">Provide a value</option> </param> <when value="__q2galaxy__::control::default"> <param name="where" type="hidden" value="__q2galaxy__::literal::None"/> </when> <when value="__q2galaxy__::control::provide"> <param name="where" type="text"> <sanitizer> <valid initial="string.printable"/> </sanitizer> </param> </when> </conditional> <param name="exclude_ids" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="exclude_ids: Bool" help="[default: No] If `True`, the samples selected by `metadata` or `where` parameters will be excluded from the filtered distance matrix instead of being retained."/> </section> </inputs> <outputs> <data name="filtered_distance_matrix" format="qza" label="${tool.name} on ${on_string}: filtered_distance_matrix.qza" from_work_dir="filtered_distance_matrix.qza"/> </outputs> <tests/> <help> QIIME 2: diversity filter-distance-matrix ========================================= Filter samples from a distance matrix. Outputs: -------- :filtered_distance_matrix.qza: Distance matrix filtered to include samples matching search criteria | Description: ------------ Filter samples from a distance matrix, retaining only the samples matching search criteria specified by `metadata` and `where` parameters (or retaining only the samples not matching that criteria, if `exclude_ids` is True). See the filtering tutorial on https://docs.qiime2.org for additional details. | </help> <citations> <citation type="doi">10.1038/s41587-019-0209-9</citation> </citations> </tool>