MetabinResult: binning result container — MetabinResult-class • metabinR

An S4 class returned by [abundance_based_binning()], [composition_based_binning()] and [hierarchical_binning()].

Usage

# S4 method for class 'MetabinResult'
show(object)

Arguments

object: A MetabinResult.

Value

Objects of this class are returned by the binning functions. Use assignments, nClusters, parameters, algorithm, or as.data.frame() to access the results.

Slots

assignments: A DataFrame of cluster assignments. The first column is read_id; subsequent columns are algorithm-specific (see the corresponding binning function).
parameters: Named list of the parameters passed to the algorithm.
inputs: Character vector of input file paths that were processed.
algorithm: Character scalar: one of "AB", "CB", "ABxCB".

Examples

res <- abundance_based_binning(
    system.file("extdata", "reads.metagenome.fasta.gz", package = "metabinR"),
    dryRun = TRUE, kMerSizeAB = 4, numOfClustersAB = 2
)
res
#> MetabinResult (AB)
#>   reads:     26,664
#>   clusters:  1
#>   inputs:    1 file(s)
#>     - /home/runner/work/_temp/Library/metabinR/extdata/reads.metagenome.fasta.gz
is(res, "MetabinResult")
#> [1] TRUE