Fork me on GitHub

merge-seqs: Combine collections of feature sequencesΒΆ

Docstring:

Usage: qiime feature-table merge-seqs [OPTIONS]

  Combines feature data objects which may or may not contain data for the same
  features. If different feature data is present for the same feature id in
  the inputs, the data from the first will be propagated to the result.

Inputs:
  --i-data ARTIFACTS... List[FeatureData[Sequence]]
                         The collection of feature sequences to be merged.
                                                                    [required]
Outputs:
  --o-merged-data ARTIFACT FeatureData[Sequence]
                         The resulting collection of feature sequences
                         containing all feature sequences provided. [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.

Examples:
  # ### example: feature table merge seqs
  qiime feature-table merge-seqs \
    --i-data seqs1.qza seqs2.qza \
    --o-merged-data merged-data.qza

Import:

from qiime2.plugins.feature_table.methods import merge_seqs

Docstring:

Combine collections of feature sequences

Combines feature data objects which may or may not contain data for the
same features. If different feature data is present for the same feature id
in the inputs, the data from the first will be propagated to the result.

Parameters
----------
data : List[FeatureData[Sequence]]
    The collection of feature sequences to be merged.

Returns
-------
merged_data : FeatureData[Sequence]
    The resulting collection of feature sequences containing all feature
    sequences provided.