summary.CaliperMatrix: S3 method for summarizing a 'CaliperMatrix'

Description Usage Arguments Value

View source: R/matrices.R

Description

Statistics return include things like sum, mean, min, etc.

Usage

1
2
## S3 method for class 'CaliperMatrix'
summary(object, ...)

Arguments

object

A CaliperMatrix object.

...

Additional arguments passed to the summary generic function.

Value

A data.frame of summary statistics. These summary statistics are always for the full Caliper matrix and do not respect the current index.

A data.frame in with a row for each core.


dkyleward/caliperR documentation built on Feb. 13, 2021, 10:35 p.m.