ordinal_probit_normalising_constant: Ordinal Probit Normalising Constant

In jpmeagher/vbar: Variational Bayes Ancestral Reconstruction

Ordinal Probit Normalising Constant

Description

Computes the probability that ordinal variables belonging to one of K ordered categories each belong to category i under the probit model given the mean of the underlying Gaussian distribution with variance 1.

Usage

ordinal_probit_normalising_constant(
  y,
  mu,
  cut_off_points,
  log_out = TRUE,
  perform_checks = TRUE
)

Arguments

y	An N-dimensional vector of ordered factors with K levels. An ordinal manifest trait.
mu	An N-dimensional vector of real numbers. The expected value of the underlying Gaussian random variable with variance 1.
cut_off_points	A K+1 dimensional ordered vector of values. The cut off points separating auxiliary traits into ordinal state.
log_out	Logical. Should the log probability be returned.
perform_checks	Logical. Check if function inputs are specified correctly.

Value

A vector of (log) probabilities.

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