Summarise components
Usage
# S3 method for class 'component'
summary(object, ..., depth = Inf, verbose = TRUE)
# S3 method for class 'component_list'
summary(object, verbose = TRUE, ...)
# S3 method for class 'component'
print(x, ...)
# S3 method for class 'component_list'
print(x, ...)
# S3 method for class 'bru_subcomponent'
format(x, verbose = TRUE, ..., label.override = NULL)
# S3 method for class 'bru_subcomponent'
summary(object, verbose = TRUE, ..., label.override = NULL)
# S3 method for class 'bru_subcomponent'
print(x, verbose = TRUE, ..., label.override = NULL)
# S3 method for class 'bru_input'
format(x, verbose = TRUE, ..., label.override = NULL, type = NULL)
# S3 method for class 'bru_input'
summary(object, verbose = TRUE, ..., label.override = NULL)
# S3 method for class 'bru_input'
print(x, verbose = TRUE, ..., label.override = NULL)
# S3 method for class 'summary_component'
print(x, ...)
# S3 method for class 'summary_component_list'
print(x, ...)
# S3 method for class 'summary_bru_subcomponent'
print(x, ...)
# S3 method for class 'summary_bru_input'
print(x, ...)
Arguments
- object
Object to be summarised.
- ...
Passed on to other summary methods.
- depth
The depth of which to expand the component mapper. Default
Inf
, to traverse the entire mapper tree.- verbose
logical; If
TRUE
, includes more details of the component definitions. WhenFALSE
, only show basic component definition information. DefaultTRUE
.- x
A summary object to be printed.
- label.override
character; If not
NULL
, use this label instead of the object's label.- type
character; if non-NULL, added to the output';
label = type(input)
.