print.cssr: Print cluster stabilty selection output

View source: R/cssr_old.R View source: R/cssr.R

print.cssrR Documentation

Print cluster stabilty selection output

Description

Print a summary of the information from the css function.

Usage

## S3 method for class 'cssr'
print(x, cutoff = 0, min_num_clusts = 0, max_num_clusts = NA, ...)

Arguments

x

An object of class "cssr" (the output of the function css).

cutoff

Numeric; print.cssr will display only those clusters with selection proportions equal to at least cutoff. Must be between 0 and 1. Default is 0 (in which case either all clusters are displayed, or max_num_clusts are, if max_num_clusts is specified).

min_num_clusts

Integer or numeric; the minimum number of clusters to use regardless of cutoff. (That is, if the chosen cutoff returns fewer than min_num_clusts clusters, the cutoff will be increased until at least min_num_clusts clusters are selected.) Default is 0.

max_num_clusts

Integer or numeric; the maximum number of clusters to use regardless of cutoff. (That is, if the chosen cutoff returns more than max_num_clusts clusters, the cutoff will be decreased until at most max_num_clusts clusters are selected.) Default is NA (in which case max_num_clusts is ignored).

...

Additional arguments (not used)

Value

A data.frame; each row contains a cluster, arranged in decreasing order of cluster selection proportion from top to bottom. The columns are ClustName (the name of the cluster that was either provided to css or made by css if no name was provided), ClustProtoName (only returned if the features have names), the name of the prototype from the cluster, which is the feature with the greatest individual selection proportion among all the cluster members (if there is a tie, it is broken by choosing the feature with the highest correlation with the response), ClustProtoNum (the column number of the prototype in the X matrix provided to css), and ClustSize (the size of the cluster).

Author(s)

Gregory Faletto, Jacob Bien


gregfaletto/cssr documentation built on March 3, 2023, 1 p.m.