Summarize a NestedScale

Complements print() with the quantitative view: per-weight totals and coverage, and the adjacent-frame nesting table. Returns a "summary_Scale" object (a list) with its own print method.

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

# S3 method for class '`nestedscales::NestedScale`'
summary(object, ...)

# S3 method for class 'summary_Scale'
print(x, ...)

Arguments

object

A NestedScale.

...

Ignored.

x

A "summary_Scale" object (the print method's argument).

Value

summary() returns a list of class "summary_Scale": name, desc, frames (named member counts), unassigned (named NA-atom counts), n_atoms, weights, weight_totals, default_weight, coverage (see scale_coverage()), sampled, parent_name, nesting (adjacent-pair table with offender counts, see scale_nests()), source, vocab.

Examples

summary(scale_example())
#> <summary of NestedScale 'example'>
#>   desc:          Synthetic example: reused code, non-nesting frame pair, and an unassigned atom
#>   frames:         sector (2) / class (3) / group (3) / unit (7)
#>   atoms:          7
#>   unassigned:     sector (1), class (1), group (1)
#>   weight totals:  size = 3,100, count =   300  (default: size)
#>   nesting:        sector > class: nested
#>   nesting:        class > group: CROSS-CUTTING (1 offender(s))
#>   nesting:        group > unit: nested