Output

Output levels

output_level = "standard" is the default. debug keeps the same final result and search trace, then adds the information needed to inspect individual candidate partitions.

Standard (default)

result
├── labels / object
├── selection
└── search_trace

Debug

result
├── labels / object
├── selection
├── search_trace
└── debug

Standard output

Domain labels

Entry pointResult locationMeaning
bcmp_embedding()result$labelsCell-ID-named character vector of BCMP domains.
bcmp() on Seuratresult$object[["bcmp_domain"]]Labels in a copied Seurat object.
bcmp() on SCEcolData(result$object)$bcmp_domainLabels in a copied SingleCellExperiment object.

Final selection

result$selection describes the final partition:

NameMeaning
selected_kRepresentation scale selected by the search.
n_domainsNumber of domains in the selected partition.
mixing_status"pass" or "fail" for the selected partition.
n_evaluated_domainsDomains used in the mixing decision.
n_residual_domains / n_residual_cellsResidual domains and their active cells.
residual_cell_fracFraction of active cells in residual domains.

Search trace

result$search_trace records the k values BCMP tested to choose selected_k; each row is one tested k:

NameMeaning
iter_id / phase / kEvaluation order, role (k_low, k_high, or k_mid), and scale.
mixing_statusMixing outcome at that scale.
n_domains / n_failed_domains / n_residual_domainsDomain counts at that scale.
actual_residual_cell_fracObserved active-cell fraction in residual domains.

Debug output

Debug output explains how the search reached its final result. It retains the standard fields and adds result$debug:

debug
├── parameters
├── search
├── candidates[[k]]
│   ├── partition
│   └── domain_summary
└── workflow                    # object workflows only
    ├── hvg_genes
    └── excluded_cell_ids

The parameters field records the values supplied for the run. search records the resolved k bounds and the final search outcome. Each candidates[[k]] entry corresponds to one tested k in search_trace; partition contains the cell-level domain labels, while domain_summary reports domain size, cell fraction, batch support, and mixing status.

For bcmp(), workflow records the selected hvg_genes and excluded_cell_ids; parameters records the resolved raw-count assay/layer and the supplied preprocessing settings. Debug object results write newly computed BCMP_PCA and BCMP_UMAP reductions in both Seurat v5 and SingleCellExperiment.