categorical.matrix: categorical constructors check inputs, convert to matrix and...

In mabafaba/categorical: Representing and Manipulating categorical data in R

Description

categorical constructors check inputs, convert to matrix and finally should call this function.

Usage

## S3 method for class 'matrix'
categorical(x = logical(), levels,
  alternatives = empty_alternatives(levels),
  alternatives_internal = empty_alternatives(levels), class = c())

Arguments

x	a logical matrix; each row corresponding to a value in the resulting vector, each column to a level / category
levels	list of possible values for x; similar to factor levels
alternatives	a named list of vectors with alternative values corresponding to 'levels'. Must have the same length as levels. Can be accessed with alternate.
alternatives_internal	a named list of vectors with alternative values corresponding to 'levels'. Must have the same length as levels. Can be accessed with alternate. "internal" alternatives are used to store 'fixed' alternatives for classes extending 'cat_categorical'.
class	optional: name the subclass if you are using this to define a new vector type on top of the 'cat_categorical' class

mabafaba/categorical documentation built on May 3, 2020, 9 p.m.