This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
This QIIME 2 plugin provides functionality for working with and visualizing Metadata.
- version:
2024.10.0 - website: https://
github .com /qiime2 /q2 -metadata - user support:
- Please post to the QIIME 2 forum for help with this plugin: https://
forum .qiime2 .org
Actions¶
| Name | Type | Short Description |
|---|---|---|
| distance-matrix | method | Create a distance matrix from a numeric Metadata column |
| shuffle-groups | method | Shuffle values in a categorical sample metadata column. |
| merge | method | Merge metadata |
| tabulate | visualizer | Interactively explore Metadata in an HTML table |
Artifact Classes¶
SampleData[ArtificialGrouping] |
Formats¶
ArtificialGroupingFormat |
ArtificialGroupingDirectoryFormat |
metadata distance-matrix¶
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
Tip: the distance matrix produced by this method can be used as input to the Mantel test available in q2-diversity.
Parameters¶
- metadata:
MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from[required]
Outputs¶
- distance_matrix:
DistanceMatrix <no description>[required]
metadata shuffle-groups¶
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.
Parameters¶
- metadata:
MetadataColumn[Categorical] Categorical metadata column to shuffle.[required]
- n_columns:
Int The number of shuffled metadata columns to create.[default:
3]- md_column_name_prefix:
Str Prefix to use in naming the shuffled metadata columns.[default:
'shuffled.grouping.']- md_column_values_prefix:
Str Prefix to use in naming the values in the shuffled metadata columns.[default:
'fake.group.']- encode_sample_size:
Bool If true, the sample size of each metadata group will be appended to the shuffled metadata column values.[default:
False]
Outputs¶
- shuffled_groups:
SampleData[ArtificialGrouping] Randomized metadata columns[required]
metadata merge¶
Merge metadata that contains overlapping ids or overlapping columns, but not both overlapping ids and overlapping columns. The result will be the union (i.e., outer join) of the ids and columns from the two metadata inputs. Attemping to merge metadata with both overlapping ids and overlapping columns will currently fail because we don't resolve conflicting column values for a sample. Merging metadata with neither overlapping ids or overlapping columns is possible with this action. To merge more than two metadata objects, run this command multiple times, iteratively using the output of the previous run as one of the metadata inputs. The output, an ImmutableMetadata artifact, can be used anywhere that a metadata file can be used, or can be exported to a metadata tsv file in the typical format.
Parameters¶
- metadata1:
Metadata First metadata file to merge.[required]
- metadata2:
Metadata Second metadata file to merge.[required]
Outputs¶
- merged_metadata:
ImmutableMetadata The merged metadata.[required]
metadata tabulate¶
Generate a tabular view of Metadata. The output visualization supports interactive filtering, sorting, and exporting to common file formats.
Parameters¶
- input:
Metadata The metadata to tabulate.[required]
- page_size:
Int The maximum number of Metadata records to display per page[default:
100]
Outputs¶
- visualization:
Visualization <no description>[required]
- Links
- Documentation
- Source Code
- Stars
- 3
- Last Commit
- 66139ab
- Available Distros
- 2024.10
- 2024.10/amplicon
- 2024.10/metagenome
- 2024.10/pathogenome
- 2024.10/tiny
- 2024.5
- 2024.5/amplicon
- 2024.5/metagenome
- 2024.2
- 2024.2/amplicon
- 2023.9
- 2023.9/amplicon
- 2023.7
- 2023.7/core