flatness_indices.matrix: Method for S3 generic function 'flatness_indices' and objects...

Description Usage Arguments Details Value

View source: R/indices.R

Description

This function is the method called when using the S3 generic function flatness_indices with an object of class matrix.

Usage

1
2
## S3 method for class 'matrix'
flatness_indices(rkhists, col_wise = FALSE, ...)

Arguments

rkhists

an object containing (rank) histograms

col_wise

a logical. Are the rank histograms stored column wise, that is one rank histogram in each column?

...

other arguments

Details

The input matrices is supposed to contain one rank histograms in each row, unless col_wise == TRUE.

Value

See Value in function flatness_indices


flatness documentation built on June 29, 2021, 9:08 a.m.