check_dist: Check if valid distance

View source: R/check.R

check_distR Documentation

Check if valid distance

Description

Check if valid distance

Usage

check_dist(x, name = "x", check_sym = TRUE)

Arguments

x

Distance matrix or array.

name

Name of x for displaying errors.

check_sym

Logical; if TRUE each matrix (slice) must be symmetric.

Details

Check if x is a valid distance vector, matrix or array. It errors if any elements in x is negative, or if x is not a symmetric matrix or an array of symmetric matrices.

Value

NULL.


mcgf documentation built on June 29, 2024, 9:09 a.m.