Warning
This site has been replaced by the new QIIME 2 “amplicon distribution” documentation, as of the 2025.4 release of QIIME 2. You can still access the content from the “old docs” here for the QIIME 2 2024.10 and earlier releases, but we recommend that you transition to the new documentation at https://amplicon-docs.qiime2.org. Content on this site is no longer updated and may be out of date.
Are you looking for:
the QIIME 2 homepage? That’s https://qiime2.org.
learning resources for microbiome marker gene (i.e., amplicon) analysis? See the QIIME 2 amplicon distribution documentation.
learning resources for microbiome metagenome analysis? See the MOSHPIT documentation.
installation instructions, plugins, books, videos, workshops, or resources? See the QIIME 2 Library.
general help? See the QIIME 2 Forum.
Old content beyond this point… 👴👵
partition-orthologs: Partition orthologs¶
Docstring:
Usage: qiime types partition-orthologs [OPTIONS]
Partition a SampleData[BLAST6] artifact into smaller artifacts containing
subsets of the BLAST6 reports.
Inputs:
--i-orthologs ARTIFACT SampleData[Orthologs]
The orthologs to partition. [required]
Parameters:
--p-num-partitions INTEGER
Range(1, None) The number of partitions to split the MAGs into.
Defaults to partitioning into individual MAGs.
[optional]
Outputs:
--o-partitioned-orthologs ARTIFACTS... Collection[SampleData[Orthologs]]
[required]
Miscellaneous:
--output-dir PATH Output unspecified results to a directory
--verbose / --quiet Display verbose output to stdout and/or stderr
during execution of this action. Or silence output
if execution is successful (silence is golden).
--example-data PATH Write example data and exit.
--citations Show citations and exit.
--use-cache DIRECTORY Specify the cache to be used for the intermediate
work of this action. If not provided, the default
cache under $TMP/qiime2/ will be used.
IMPORTANT FOR HPC USERS: If you are on an HPC system
and are using parallel execution it is important to
set this to a location that is globally accessible
to all nodes in the cluster.
--help Show this message and exit.
Import:
from qiime2.plugins.types.methods import partition_orthologs
Docstring:
Partition orthologs
Partition a SampleData[BLAST6] artifact into smaller artifacts containing
subsets of the BLAST6 reports.
Parameters
----------
orthologs : SampleData[Orthologs]
The orthologs to partition.
num_partitions : Int % Range(1, None), optional
The number of partitions to split the MAGs into. Defaults to
partitioning into individual MAGs.
Returns
-------
partitioned_orthologs : Collection[SampleData[Orthologs]]