print.objects.summary: Print Method for 'objects.summary' Objects

In osum: Provide Summary Information About R Objects

Print Method for objects.summary Objects

Description

Print an object of class objects.summary with some specific formatting options before using print.data.frame.

Usage

## S3 method for class 'objects.summary'
print(
  x,
  ...,
  data.class.width = getOption("osum.data.class.width", default = NULL),
  format.extent = getOption("osum.format.extent", default = TRUE),
  max.rows = getOption("osum.max.rows", default = NULL)
)

Arguments

x	object of class objects.summary
...	further arguments to be passed down to print.data.frame (should not include max)
data.class.width	integer indicating the width of the data.class field when it is a list (when objects.summary was called with all.classes = TRUE). Default: getOption("osum.data.class.width", default = NULL)
format.extent	logical indicating whether the extent field should be formatted as product (d1 x d2) or left as list (d1, d2). Default: getOption("osum.format.extent", default = TRUE)
max.rows	integer, maximal number of rows to print. Default: getOption("osum.max.rows", default = NULL)

Details

max.rows computes an adequate value to be passed as max argument to print.data.frame. By default, when NULL, getOption("max.print") is used by print.data.frame.

Value

No return value, called for side effects.

See Also

objects.summary, print.data.frame

Examples

print(objects.summary("package:datasets", all.classes = FALSE),
    format.extent = FALSE, max.rows = 6)
print(objects.summary("package:datasets", all.classes = TRUE, data.class = "array"),
    data.class.width = 22, format.extent = TRUE, max.rows = 6)

osum documentation built on Sept. 11, 2024, 5:58 p.m.