Fork me on GitHub

partition-samples-paired: Split demultiplexed sequence data into partitions.ΒΆ

Docstring:

Usage: qiime demux partition-samples-paired [OPTIONS]

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

Inputs:
  --i-demux ARTIFACT SampleData[PairedEndSequencesWithQuality]
                         The demultiplexed sequences to partition.  [required]
Parameters:
  --p-num-partitions INTEGER
    Range(1, None)       The number of partitions to split the demultiplexed
                         sequences into. Defaults to partitioning into
                         individual samples.                        [optional]
Outputs:
  --o-partitioned-demux ARTIFACTS...
    Collection[SampleData[PairedEndSequencesWithQuality]]
                         The partitioned demultiplexed sequences.   [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.demux.methods import partition_samples_paired

Docstring:

Split demultiplexed sequence data into partitions.

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

Parameters
----------
demux : SampleData[PairedEndSequencesWithQuality]
    The demultiplexed sequences to partition.
num_partitions : Int % Range(1, None), optional
    The number of partitions to split the demultiplexed sequences into.
    Defaults to partitioning into individual samples.

Returns
-------
partitioned_demux : Collection[SampleData[PairedEndSequencesWithQuality]]
    The partitioned demultiplexed sequences.