category_vector: Category vector

View source: R/category_vector.R

category_vectorR Documentation

Category vector

Description

Convert an object containing binary (integer) columns into a integer vector indicating the column index where each row is 1.

Usage

category_vector(x)

## S3 method for class 'data.frame'
category_vector(x)

## S3 method for class 'sf'
category_vector(x)

## S3 method for class 'Spatial'
category_vector(x)

## S3 method for class 'matrix'
category_vector(x)

Arguments

x

matrix, data.frame, or sf::sf() object.

Details

This function is conceptually similar to base::max.col() except that rows with no values equal to 1 values are assigned a value of zero. Also, note that in the argument to x, each row must contain only a single value equal to 1.

Value

An integer vector.

See Also

base::max.col()

Examples

# create matrix with logical columns
x <- matrix(c(1, 0, 0, NA, 0, 1, 0, NA, 0, 0, 0, NA), ncol = 3)

# print matrix
print(x)

# convert to category vector
y <- category_vector(x)

# print category vector
print(y)

prioritizr/prioritizr documentation built on July 5, 2024, 2:14 p.m.