label {SIAMCAT} | R Documentation

## Retrieve the label from a SIAMCAT object

### Description

Retrieve the label from a SIAMCAT object

### Usage

    label(siamcat, verbose=1)

    ## S4 method for signature 'siamcat'
    label(siamcat, verbose = 1)

### Arguments

`siamcat` | (Required). A siamcat-class object
`verbose` | integer, if the slot is empty, should a message be printed? values can be either `0` (no output) or `1` (print message)

### Details

This function will retrieve the label information from a SIAMCAT object. The label will contain three entries:

- `label`: The label as named vector, in which the classes are encoded numerically

- `info`: Information about the different classes

- `type`: What kind of label is it?

### Value

The label or NULL.

### Examples

    data(siamcat_example)
    temp <- label(siamcat_example)
    head(temp$label)
    temp$info
    temp$type

[Package SIAMCAT version 1.12.0 Index]