Structured summary of SCM search results

Returns a programmatic digest of an scmSearchResult object (from shotgunSearch or stepwiseSearch). Run-context fields recorded as attributes – resolved estimation method (from params@method), runMode, wall-clock runTime$elapsed, and RsNLMEVersion – are surfaced alongside the scenario inventory. Older archives that lack any of these attributes silently omit the corresponding fields.

Usage

# S3 method for class 'scmSearchResult'
summary(object, ...)

Arguments

object

A scmSearchResult object.

...

Unused.

Value

An object of class c("summary.scmSearchResult", "list") with elements:

searchType

One of "stepwise", "shotgun", or NA when the type cannot be resolved.

searchRunDir

Archive folder path, or NULL for unarchived results.

nScenarios

Number of scenarios evaluated.

nBest

0L or 1L – whether a best scenario is recorded.

nFailed

Count of scenarios whose archive status is not SUCCESS.

nSucceeded

Count of scenarios whose archive status is SUCCESS.

bestScenario

A named list with the best scenario label, available -2LL / AIC / BIC criteria, and status when the archive reports one. For a 1-row object with no recorded best, this is that row so a failed subset still carries its status. NULL when no scenario is recorded.

topScenarios

A data frame with all ranked scenarios (same ordering as print.scmSearchResult), with best and failed logical columns.

scenarioIndex

Path to scenario_index.csv when searchRunDir is set; otherwise NULL.

runContext

Named list with method, runMode, elapsed, RsNLMEVersion; absent slots are silently dropped.

Details

topScenarios contains every ranked scenario so the digest stays lossless for programmatic consumers; display truncation is the job of print.summary.scmSearchResult via its own n argument.

See also

shotgunSearch, stepwiseSearch, getSCMResults, scmSearchTable, print.scmSearchResult, print.summary.scmSearchResult