check_Xvar: Internal: check for valid name of Xvar

View source: R/utils.R

check_XvarR Documentation

Internal: check for valid name of Xvar

Description

Users should always specify Xvar as "NAME_SIMPLEX", which means before log-ratio transformations.

Usage

check_Xvar(
  Xvar,
  trSry,
  return_type = c("NAME_SIMPLEX", "NAME_COORD", "pos")[1]
)

Arguments

Xvar

a character or numeric indicating the direction

trSry

a character indicating the names of the vertices

Value

a single integer or character

Author(s)

Lukas Dargel


CoDaImpact documentation built on May 29, 2024, 3:40 a.m.