Retrieve the label from a SIAMCAT object

label(siamcat, verbose=1)

# S4 method for 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)

Value

The label or NULL.

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?

Examples

data(siamcat_example) temp <- label(siamcat_example) head(temp$label)
#> CCIS27304052ST-3-0 CCIS15794887ST-4-0 CCIS74726977ST-3-0 CCIS16561622ST-4-0 #> -1 -1 -1 -1 #> CCIS79210440ST-3-0 CCIS82507866ST-3-0 #> -1 -1
temp$info
#> CTR CRC #> -1 1
temp$type
#> [1] "BINARY"