qiime diversity filter-distance-matrix (version 2019.4)

--i-distance-matrix: ARTIFACT DistanceMatrix Distance matrix to filter by sample. [required]:

--p-where: TEXT 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. [optional]:

--p-exclude-ids: --p-no-exclude-ids If `True`, the samples selected by `metadata` or `where` parameters will be excluded from the filtered distance matrix instead of being retained. [default: False]:

--m-metadata-file [required]s

--m-metadata-file [required] 0

Filter samples from a distance matrix.

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.

Parameters

distance_matrix : DistanceMatrix: Distance matrix to filter by sample.
metadata : Metadata: Sample metadata used with where parameter when selecting samples to retain, or with exclude_ids when selecting samples to discard.
where : Str, 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.
exclude_ids : Bool, optional: If True, the samples selected by metadata or where parameters will be excluded from the filtered distance matrix instead of being retained.

Returns

filtered_distance_matrix : DistanceMatrix: Distance matrix filtered to include samples matching search criteria