recession_cone: Recession cone calculation

View source: R/generics.R

recession_coneR Documentation

Recession cone calculation

Description

This function calculates the dimension of the recession cone and returns the recession cone.

Usage

recession_cone(object, ...)

## Default S3 method:
recession_cone(object, ...)

## S3 method for class 'factor'
recession_cone(object, X, model = NULL, rational = FALSE, ...)

## S3 method for class 'character'
recession_cone(object, X, model = NULL, rational = FALSE, ...)

## S3 method for class 'logical'
recession_cone(object, X, model = NULL, rational = FALSE, ...)

## S3 method for class 'numeric'
recession_cone(object, X, model = NULL, rational = FALSE, ...)

## S3 method for class 'integer'
recession_cone(object, X, model = NULL, rational = FALSE, ...)

## S3 method for class 'matrix'
recession_cone(object, rational = FALSE, ...)

## S3 method for class 'formula'
recession_cone(
  object,
  data,
  model = NULL,
  rational = FALSE,
  contrasts = NULL,
  ...
)

## S3 method for class 'osm'
recession_cone(object, rational = FALSE, ...)

## S3 method for class 'clm'
recession_cone(object, rational = FALSE, ...)

## S3 method for class 'polr'
recession_cone(object, rational = FALSE, ...)

## S3 method for class 'multinom'
recession_cone(object, rational = FALSE, ...)

## S3 method for class 'glm'
recession_cone(object, rational = FALSE, ...)

## S3 method for class 'bracl'
recession_cone(object, rational = FALSE, ...)

## S3 method for class 'brmultinom'
recession_cone(object, rational = FALSE, ...)

Arguments

object

an R object. Supported inputs:

  • Pre-fit (vector): a vector of type factor, character, logical, numeric or integer. In this case one also needs to supply the argument X and, optionally but recommended, a model.

  • Pre-fit (matrix): a matrix of structure vectors.

  • Pre-fit (formula): an object of class "formula" (or one that can be coerced to that class): a symbolic description of the model to be fitted. The details of model specification are given under ‘Details’ in glm. In this case one needs to supply data, with an optional model argument as well.

  • Post-fit: a fitted model object of class glm, polr, clm, osm, brmultinom, bracl, brglm or multinom.

...

further arguments passed to the methods or lower-level functions.

X

a design matrix, e.g. generated via a call to model.matrix. X is expected to already contain the desired contrasts for factors (e.g., dummies) and any other expanded columns (e.g., for polynomials).

model

character string specifying the model class to be fitted. One of:

  • "b" – binary

  • "bcl" – baseline-category link

  • "cl" – cumulative link

  • "acl" – adjacent-category link

  • "sl" – sequential link

  • "os" – ordered stereotype model

If missing or NULL, defaults to "cl" for ordinal y and "bcl" otherwise.

rational

logical; should rational arithmetic be used.

data

either a standard data frame, list or environment (or object coercible by as.data.frame to a data frame) containing the variables in the model. If not found in data, the variables are taken from environment(formula), typically the environment from which the function is called.

Alternatively, data can be a data frame or matrix containing rational numbers as per the definition in rcdd (i.e. columns are characters, entries are either integer numbers or ratios of integer numbers, e.g. "1" or "-234/19008"). This is checked internally; see ‘Details’ for what happens when this structure is discovered.

contrasts

an optional list. See the contrasts.arg of model.matrix.default. Only effective for standard data frames.

Details

Note that in case of non full column rank, the 'reccdim' value is the dimension of the recession cone due to separation plus the number of columns that are linear dependent.

The formula method is for standard data frames and formulas that work the same way as when used with glm. It does not support extended formulas, and may not work for functions that do formula processing differently.

For a data frame or matrix given as rational numbers in the rcdd definition, this is recognized but the formula does not get expanded and is taken literally. Consequently:

  • variables in formula must match exactly with the column names in data;

  • factors need to be converted to dummies beforehand (which would not be possible in the rational format in any other way anyway).

Value

A list with the components:

  • cone being the recession cone,

  • reccdim being the dimensions of the recession cone

  • index the row index of the structure vectors that are not linearities.

For model = "sl" 'cone' is the recession cone over all categories, 'reccdim' the dimension of the largest recession cone of any category and 'index' the row index of the structure vectors that are not linearities over all categories.

Examples


## Binary data
data(csepdat1)
outc<-csepdat1$y
desma<-cbind("(Intercept)"=1,csepdat1[,2:ncol(csepdat1)])
recession_cone(outc, X = desma, model = "b")

# Nominal data 
# Baseline-category link
data(qcsepdatm)
y<-qcsepdatm$y
X<-cbind(1,qcsepdatm[,2:ncol(qcsepdatm)])
recession_cone(y, X = X, model = "bcl")

# Ordinal data
data(qcsepdato)
yo<-qcsepdato$y
Xo<-qcsepdato[,2:ncol(qcsepdato)]

# Sequential link
recession_cone(yo, Xo, model = "sl")

# Ordered stereotype
recession_cone(yo, Xo, model = "os")

# Adjacent-category link
recession_cone(yo, Xo, model= "acl")

# Cumulative link
recession_cone(yo, Xo, model = "cl")

# post fit
if (require('ordinal')) {
m1 <- ordinal::clm(y~x1+x2, data = qcsepdato)
recession_cone(m1)
}

divoRce documentation built on Oct. 18, 2026, 5:08 p.m.