is_standard: Check if a numeric matrix generated with 'make_adjacency'...

View source: R/is_standard.R

is_standardR Documentation

Check if a numeric matrix generated with make_adjacency fulfills the edgynode standard format

Description

This function takes an adjacency matrix as input and checks if it is in a standard form (based on the options provided).

Usage

is_standard(adj, max_value = 1, no_negative = TRUE, no_self_loops = TRUE)

Arguments

adj

an adjacency matrix converted from a raw input matrix via make_adjacency.

max_value

the maximum (positive) value that should exist in the matrix; default is 1; setting this to NULL or max(abs(adj)) leaves the values unchanged

no_negative

whether there should be negative values or just their absolute value (e.g. in the case of correlations); default is no_negative = TRUE.

no_self_loops

whether the values in the main diagonal of the adjacency matrix should be 0; default is no_negative = TRUE.

Author(s)

Ilias Moutsopoulos


drostlab/edgynode documentation built on March 29, 2024, 10:36 a.m.