Learn R Programming

flatness (version 0.1.4)

flatness_indices.matrix: Method for S3 generic function flatness_indices and objects with class matrix

Description

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

Usage

# S3 method for 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

Value

See Value in function flatness_indices

Details

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