infoSumOfProbes: pepsirf info (sum of probes) moduleΒΆ

Docstring:

Usage: qiime pepsirf infoSumOfProbes [OPTIONS]

  Gathers the sum of probes per sample in the matrix using pepsirf's info
  module

Inputs:
  --i-input ARTIFACT FeatureTable[Normed | NormedDifference |
    NormedDiffRatio | RawCounts | NormedSized]
                       An input score matrix to gather information from.
                                                                    [required]
Parameters:
  --p-outfile TEXT     The outfile that will produce a list of inputs to
                       PepSIRF.                        [default: './info.out']
  --p-pepsirf-binary TEXT
                       The binary to call pepsirf on your system.
                                                          [default: 'pepsirf']
Outputs:
  --o-sum-of-probes-output ARTIFACT
    InfoSumOfProbes    InfoSumOfProbes file, The first entry in each column
                       will be the name of the sample, and the second will be
                       the sum of the peptide/probe scores for the sample.
                                                                    [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.
  --help               Show this message and exit.

Import:

from qiime2.plugins.pepsirf.methods import infoSumOfProbes

Docstring:

pepsirf info (sum of probes) module

Gathers the sum of probes per sample in the matrix using pepsirf's info
module

Parameters
----------
input : FeatureTable[Normed | NormedDifference | NormedDiffRatio | RawCounts | NormedSized]
    An input score matrix to gather information from.
outfile : Str, optional
    The outfile that will produce a list of inputs to PepSIRF.
pepsirf_binary : Str, optional
    The binary to call pepsirf on your system.

Returns
-------
sum_of_probes_output : InfoSumOfProbes
    InfoSumOfProbes file, The first entry in each column will be the name
    of the sample, and the second will be the sum of the peptide/probe
    scores for the sample.