print.hdistance: Print method for class hdistance (Hartmann distance objects).

View source: R/distance.R

print.hdistanceR Documentation

Print method for class hdistance (Hartmann distance objects).

Description

Additionally allows the specification of p-values. The corresponding quantiles are calculated. These are contained as attributes in the hdistance object as returned by distanceHartmann. The lowest and highest values are used as cutoffs in print.distance.

Usage

## S3 method for class 'hdistance'
print(
  x,
  digits = 2,
  col.index = TRUE,
  upper = TRUE,
  diag = FALSE,
  cutoffs = NA,
  p = NA,
  ...
)

Arguments

x

Object of class hdistance.

digits

Numeric. Number of digits to round to (default is 2).

col.index

Logical. Whether to add an extra index column so the column names are indexes instead of construct names. This option renders a neater output as long construct names will stretch the output (default is TRUE).

upper

Whether to display upper triangle of correlation matrix only (default is TRUE).

diag

Whether to show the matrix diagonal.

cutoffs

Cutoff values. Values below or above this interval are not printed. For Slater distances c(.8, 1.2) are common values.

p

Quantiles corresponding to probabilities are used as cutoffs. Currently only works for Hartmann distances. If used cutoffs is overwritten.

...

Not evaluated.


OpenRepGrid documentation built on May 31, 2023, 5:33 p.m.