summary.proximus: Summarizing Proximus Objects

Description Usage Arguments Value Warning Author(s) See Also Examples

View source: R/proximus.r

Description

summary method for an object of class proximus.

Usage

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

Arguments

object

an object of class proximus.

...

further (unused) arguments.

Value

An object of class summary.proximus with the following elements:

nr

the number of rows of the approximated matrix.

nc

the number of columns of the approximated matrix.

error

the relative error of the total approximation.

fnorm

the Frobenius norm of the total approximation.

jsim

the Jaccard similarity of the total approximation.

valid

the number of patterns that satisfy the mining constraints.

pattern

a data.frame of pattern summaries:

pattern$Size

the absolute size of the presence set.

pattern$Length

the number of TRUE values of the dominant pattern.

pattern$Radius

the Hamming radius of the presence set.

pattern$Error

the relative error of the presence set.

pattern$Fnorm

the Frobenius norm of the presence set.

pattern$Jsim

the Jaccard similarity of the presence set.

pattern$Valid

a logical indicating if the constraints are satisfied.

Warning

The function may change in future releases

Author(s)

Christian Buchta

See Also

proximus for obtaining a result object.

Examples

1
### see proximus

cba documentation built on May 2, 2019, 1:39 p.m.

Related to summary.proximus in cba...