format.lassie: Format a lassie object

View source: R/lassie.R

format.lassieR Documentation

Format a lassie object

Description

Formats a lassie object for printing to console (see print.lassie) and for writing to a file (see write.lassie). Melts probability or local association measure arrays into a data.frame.

Usage

## S3 method for class 'lassie'
format(x, what_x, range, what_range, what_sort, decreasing, na.rm, ...)

Arguments

x

lassie S3 object.

what_x

vector specifying values to be returned:

  • 'local': local association measure values (default).

  • 'obs': observed probabilities.

  • 'exp': expected probabilities.

  • 'local_p': p-value of local association (after running permtest or chisqtest).

range

range of values to be retained (vector of two numeric values).

what_range

character specifying what value range refers to (same options as what_x). By default, takes the first value in what_x.

what_sort

character specifying according to which values should x be sorted (same options as what_x). By default, takes the first value in what_x.

decreasing

logical value specifying sort order.

na.rm

logical value indicating whether NA values should be stripped.

...

other arguments passed on to methods. Not currently used.

See Also

lassie


zebu documentation built on Aug. 25, 2023, 5:17 p.m.