This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]

This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]

This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]

This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]

This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]

This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]

This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]

This QIIME 2 plugin defines semantic types and transformers supporting microbiome analysis.

version: 2025.7.0.dev0
website: https://github.com/qiime2/q2-types
user support:
Please post to the QIIME 2 forum for help with this plugin: https://forum.qiime2.org

Actions

NameTypeShort Description
partition-sample-data-magsmethodPartition MAGs
partition-samples-singlemethodSplit demultiplexed sequence data into partitions.
partition-samples-pairedmethodSplit demultiplexed sequence data into partitions.
partition-orthologsmethodPartition orthologs
collate-sample-data-magsmethodCollate MAGs
partition-feature-data-magsmethodPartition MAGs
collate-feature-data-magsmethodCollate MAGs
collate-orthologsmethodCollate orthologs
collate-ortholog-annotationsmethodCollate ortholog annotations.
collate-locimethodCollate loci
collate-kraken2-reportsmethodCollate kraken2 reports.
collate-kraken2-outputsmethodCollate kraken2 outputs.
partition-kraken2-reportsmethodPartition kraken2 reports.
partition-kraken2-outputsmethodPartition kraken2 outputs.

Artifact Classes

Bowtie2Index
DistanceMatrix
FeatureData[Taxonomy]
FeatureData[Sequence]
FeatureData[RNASequence]
FeatureData[PairedEndSequence]
FeatureData[PairedEndRNASequence]
FeatureData[AlignedSequence]
FeatureData[AlignedRNASequence]
FeatureData[Differential]
FeatureData[ProteinSequence]
FeatureData[AlignedProteinSequence]
FeatureData[BLAST6]
FeatureData[SequenceCharacteristics]
FeatureData[MAG]
FeatureData[Contig]
FeatureData[SingleBowtie2Index]
FeatureMap[MAGtoContigs]
FeatureTable[Frequency]
FeatureTable[RelativeFrequency]
FeatureTable[PresenceAbsence]
FeatureTable[Balance]
FeatureTable[Composition]
FeatureTable[PercentileNormalized]
FeatureTable[Design]
FeatureTable[Normalized]
GenomeData[Genes]
GenomeData[Proteins]
GenomeData[Loci]
GenomeData[Orthologs]
GenomeData[DNASequence]
GenomeData[NOG]
SampleData[Orthologs]
SampleData[NOG]
KaijuDB
SampleData[Kraken2Report]
FeatureData[Kraken2Report]
SampleData[Kraken2Output]
FeatureData[Kraken2Output]
Kraken2DB
Kraken2DBReport
BrackenDB
ImmutableMetadata
MultiplexedSingleEndBarcodeInSequence
MultiplexedPairedEndBarcodeInSequence
RawSequences
EMPSingleEndSequences
EMPPairedEndSequences
ErrorCorrectionDetails
PCoAResults
ProcrustesStatistics
SampleData[Sequences]
SampleData[SequencesWithQuality]
SampleData[JoinedSequencesWithQuality]
SampleData[PairedEndSequencesWithQuality]
SampleData[MAGs]
SampleData[Contigs]
SampleData[SingleBowtie2Index]
SampleData[MultiBowtie2Index]
SampleData[AlignmentMap]
FeatureData[AlignmentMap]
SampleData[MultiAlignmentMap]
ProfileHMM[PressedProtein]
ProfileHMM[PressedDNA]
ProfileHMM[PressedRNA]
ProfileHMM[SingleProtein]
ProfileHMM[SingleDNA]
ProfileHMM[SingleRNA]
ProfileHMM[MultipleProtein]
ProfileHMM[MultipleDNA]
ProfileHMM[MultipleRNA]
ReferenceDB[Eggnog]
ReferenceDB[Diamond]
ReferenceDB[NCBITaxonomy]
ReferenceDB[EggnogProteinSequences]
SampleData[AlphaDiversity]
Phylogeny[Unrooted]
Phylogeny[Rooted]
Hierarchy
Dist1D[NestedOrdered, Independent]
Dist1D[NestedUnordered, Matched]
Dist1D[Multi, Matched]
Dist1D[Unordered, Independent]
Dist1D[Ordered, Independent]
Dist1D[NestedOrdered, Matched]
Dist1D[Unordered, Matched]
Dist1D[Multi, Independent]
Dist1D[Ordered, Matched]
Dist1D[NestedUnordered, Independent]
StatsTable[Pairwise]

Formats

Bowtie2IndexDirFmt
LSMatFormat
DistanceMatrixDirectoryFormat
TSVTaxonomyFormat
TSVTaxonomyDirectoryFormat
HeaderlessTSVTaxonomyFormat
HeaderlessTSVTaxonomyDirectoryFormat
TaxonomyFormat
TaxonomyDirectoryFormat
FASTAFormat
DNAFASTAFormat
DNASequencesDirectoryFormat
PairedDNASequencesDirectoryFormat
AlignedDNAFASTAFormat
AlignedDNASequencesDirectoryFormat
DifferentialFormat
DifferentialDirectoryFormat
ProteinFASTAFormat
AlignedProteinFASTAFormat
MixedCaseProteinFASTAFormat
MixedCaseAlignedProteinFASTAFormat
ProteinSequencesDirectoryFormat
AlignedProteinSequencesDirectoryFormat
MixedCaseProteinSequencesDirectoryFormat
MixedCaseAlignedProteinSequencesDirectoryFormat
RNAFASTAFormat
RNASequencesDirectoryFormat
AlignedRNAFASTAFormat
AlignedRNASequencesDirectoryFormat
PairedRNASequencesDirectoryFormat
BLAST6Format
BLAST6DirectoryFormat
MixedCaseDNAFASTAFormat
MixedCaseDNASequencesDirectoryFormat
MixedCaseRNAFASTAFormat
MixedCaseRNASequencesDirectoryFormat
MixedCaseAlignedDNAFASTAFormat
MixedCaseAlignedDNASequencesDirectoryFormat
MixedCaseAlignedRNAFASTAFormat
MixedCaseAlignedRNASequencesDirectoryFormat
SequenceCharacteristicsFormat
SequenceCharacteristicsDirectoryFormat
MAGSequencesDirFmt
MAGtoContigsFormat
MAGtoContigsDirFmt
BIOMV100Format
BIOMV210Format
BIOMV100DirFmt
BIOMV210DirFmt
GenesDirectoryFormat
ProteinsDirectoryFormat
LociDirectoryFormat
GenomeSequencesDirectoryFormat
OrthologFileFmt
SeedOrthologDirFmt
OrthologAnnotationDirFmt
GFF3Format
KaijuDBDirectoryFormat
KaijuIndexFormat
Kraken2ReportFormat
Kraken2OutputFormat
Kraken2DBFormat
Kraken2DBReportFormat
Kraken2ReportDirectoryFormat
Kraken2OutputDirectoryFormat
Kraken2DBDirectoryFormat
Kraken2DBReportDirectoryFormat
BrackenDBFormat
BrackenDBDirectoryFormat
ImmutableMetadataFormat
ImmutableMetadataDirectoryFormat
MultiplexedSingleEndBarcodeInSequenceDirFmt
MultiplexedPairedEndBarcodeInSequenceDirFmt
MultiplexedFastaQualDirFmt
EMPMultiplexedDirFmt
ErrorCorrectionDetailsDirFmt
ErrorCorrectionDetailsFmt
EMPSingleEndDirFmt
EMPSingleEndCasavaDirFmt
EMPPairedEndDirFmt
EMPPairedEndCasavaDirFmt
OrdinationFormat
OrdinationDirectoryFormat
ProcrustesStatisticsFmt
ProcrustesStatisticsDirFmt
FastqManifestFormat
FastqAbsolutePathManifestFormat
YamlFormat
FastqGzFormat
CasavaOneEightSingleLanePerSampleDirFmt
CasavaOneEightLanelessPerSampleDirFmt
SingleLanePerSampleSingleEndFastqDirFmt
SingleLanePerSamplePairedEndFastqDirFmt
SingleEndFastqManifestPhred33
SingleEndFastqManifestPhred64
PairedEndFastqManifestPhred33
PairedEndFastqManifestPhred64
SingleEndFastqManifestPhred33V2
SingleEndFastqManifestPhred64V2
PairedEndFastqManifestPhred33V2
PairedEndFastqManifestPhred64V2
QIIME1DemuxFormat
QIIME1DemuxDirFmt
SampleIdIndexedSingleEndPerSampleDirFmt
MultiFASTADirectoryFormat
MultiMAGSequencesDirFmt
ContigSequencesDirFmt
MultiBowtie2IndexDirFmt
BAMFormat
BAMDirFmt
MultiBAMDirFmt
MultiMAGManifestFormat
ProteinMultipleProfileHmmFileFmt
ProteinSingleProfileHmmFileFmt
RNAMultipleProfileHmmFileFmt
RNASingleProfileHmmFileFmt
DNAMultipleProfileHmmFileFmt
DNASingleProfileHmmFileFmt
PressedProfileHmmsDirectoryFmt
ProteinSingleProfileHmmDirectoryFmt
ProteinMultipleProfileHmmDirectoryFmt
DNASingleProfileHmmDirectoryFmt
DNAMultipleProfileHmmDirectoryFmt
RNASingleProfileHmmDirectoryFmt
RNAMultipleProfileHmmDirectoryFmt
EggnogRefTextFileFmt
EggnogRefBinFileFmt
EggnogRefDirFmt
DiamondDatabaseFileFmt
DiamondDatabaseDirFmt
NCBITaxonomyNodesFormat
NCBITaxonomyNamesFormat
NCBITaxonomyBinaryFileFmt
NCBITaxonomyDirFmt
EggnogProteinSequencesDirFmt
AlphaDiversityFormat
AlphaDiversityDirectoryFormat
NewickFormat
NewickDirectoryFormat
NDJSONFileFormat
DataResourceSchemaFileFormat
TabularDataResourceDirFmt
TableJSONLFileFormat
TableJSONLDirFmt


types partition-sample-data-mags

Partition a SampleData[MAGs] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: SampleData[MAGs]

The MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[SampleData[MAGs]]

<no description>[required]


types partition-samples-single

Partition demultiplexed single end or joined sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[SequencesWithQuality¹ | JoinedSequencesWithQuality²]]

The partitioned demultiplexed sequences.[required]


types partition-samples-paired

Partition demultiplexed paired end sequences into individual samples or the number of partitions specified.

Inputs

demux: SampleData[PairedEndSequencesWithQuality]

The demultiplexed sequences to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the demultiplexed sequences into. Defaults to partitioning into individual samples.[optional]

Outputs

partitioned_demux: Collection[SampleData[PairedEndSequencesWithQuality]]

The partitioned demultiplexed sequences.[required]


types partition-orthologs

Partition a SampleData[BLAST6] artifact into smaller artifacts containing subsets of the BLAST6 reports.

Inputs

orthologs: SampleData[Orthologs]

The orthologs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_orthologs: Collection[SampleData[Orthologs]]

<no description>[required]


types collate-sample-data-mags

Takes a collection of SampleData[MAGs]'s and collates them into a single artifact.

Inputs

mags: List[SampleData[MAGs]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: SampleData[MAGs]

<no description>[required]


types partition-feature-data-mags

Partition a FeatureData[MAG] artifact into smaller artifacts containing subsets of the MAGs

Inputs

mags: FeatureData[MAG]

MAGs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The number of partitions to split the MAGs into. Defaults to partitioning into individual MAGs.[optional]

Outputs

partitioned_mags: Collection[FeatureData[MAG]]

<no description>[required]


types collate-feature-data-mags

Takes a collection of FeatureData[MAG]'s and collates them into a single artifact.

Inputs

mags: List[FeatureData[MAG]]

A collection of MAGs to be collated.[required]

Outputs

collated_mags: FeatureData[MAG]

<no description>[required]


types collate-orthologs

Takes a collection SampleData[BLAST6] artifacts and collates them into a single artifact.

Inputs

orthologs: List[SampleData[Orthologs]]

Orthologs to collate[required]

Outputs

collated_orthologs: SampleData[Orthologs]

<no description>[required]


types collate-ortholog-annotations

Takes a collection of GenomeData[NOG]'s and collates them into a single artifact.

Inputs

ortholog_annotations: List[GenomeData[NOG]]

Collection of ortholog annotations.[required]

Outputs

collated_annotations: GenomeData[NOG]

Collated ortholog annotations.[required]


types collate-loci

Takes a collection of GenomeData[Loci]'s and collates them into a single artifact.

Inputs

loci: List[GenomeData[Loci]]

A collection of loci to be collated.[required]

Outputs

collated_loci: GenomeData[Loci]

<no description>[required]


types collate-kraken2-reports

Inputs

kraken2_reports: List[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The kraken2 reports to collate.[required]

Outputs

collated_kraken2_reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The collated kraken2 reports.[required]


types collate-kraken2-outputs

Inputs

kraken2_outputs: List[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The kraken2 outputs to collate.[required]

Outputs

collated_kraken2_outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The collated kraken2 outputs.[required]


types partition-kraken2-reports

Inputs

reports: SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]

The kraken2 reports to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_reports: Collection[SampleData[Kraken2Report % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Report % Properties('contigs', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'mags')] | SampleData[Kraken2Report % Properties('reads', 'contigs')] | SampleData[Kraken2Report % Properties('reads')] | SampleData[Kraken2Report % Properties('contigs')] | SampleData[Kraken2Report % Properties('mags')] | FeatureData[Kraken2Report % Properties('mags')]]

The partitioned kraken2 reports.[required]


types partition-kraken2-outputs

Inputs

outputs: SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]

The kraken2 outputs to partition.[required]

Parameters

num_partitions: Int % Range(1, None)

The desired number of partitions. Defaults to one partition per sample.[optional]

Outputs

partitioned_outputs: Collection[SampleData[Kraken2Output % Properties('reads', 'contigs', 'mags')] | SampleData[Kraken2Output % Properties('contigs', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'mags')] | SampleData[Kraken2Output % Properties('reads', 'contigs')] | SampleData[Kraken2Output % Properties('reads')] | SampleData[Kraken2Output % Properties('contigs')] | SampleData[Kraken2Output % Properties('mags')] | FeatureData[Kraken2Output % Properties('mags')]]

The partitioned kraken2 outputs.[required]