get_numerator: Get numerator of association indices

View source: R/convenience_functions.R

get_numeratorR Documentation

Get numerator of association indices

Description

For many functions, the numerator of association indices is needed, rather than the final network. This function allows to user to easily extract these.

Usage

get_numerator(data, data_format = "SP", return = "vector")

Arguments

data

The association data

data_format

Character, indicating what form the data is in.

return

Character, indicating whether a vector or square matrix should be returned

Details

The association index does not need to be specified, as they almost all use the same numerator. Data format can be either "SP" or "GBI", the two main data formats used by "asnipe".

Value

Either a vector of numerators (if return = "vector") or a square matrix of numerators (if return = "matrix").


MNWeiss/aninet documentation built on Jan. 31, 2023, 3:55 a.m.