ordinal_inverse_link: Ordinal Trait Inverse Link Function

In jpmeagher/vbar: Variational Bayes Ancestral Reconstruction

Ordinal Trait Inverse Link Function

Description

Map an ordinal manifest trait to an auxiliary trait.

Usage

ordinal_inverse_link(
  y,
  cut_off_points,
  mu,
  return_expectation = TRUE,
  random_seed = NULL,
  perform_checks = TRUE
)

Arguments

y	An N-dimensional vector of ordered factors with K levels. An ordinal manifest trait.
cut_off_points	A K+1 dimensional ordered vector of values. The cut off points separating auxiliary traits into ordinal state.
mu	An N-dimensional vector of real numbers. The expected value of the underlying Gaussian random variable with variance 1.
return_expectation	Logical. Should manifest variables map to the expected auxiliary variable or to values sampled from the truncated Gaussian distribution.
random_seed	A single value, interpreted as an integer, or NULL.
perform_checks	Logical. Check if function inputs are specified correctly.

Value

An N-dimensional vector of real numbers. An auxiliary trait.

jpmeagher/vbar documentation built on Nov. 22, 2022, 5:48 a.m.