model_list {SIAMCAT} | R Documentation

## Retrieve the information stored in the `model_list` slot within a SIAMCAT object

### Description

Function to retrieve the information stored in the `model_list` slot within a SIAMCAT object

### Usage

    model_list(siamcat, verbose=1)

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

### Arguments

`siamcat` | (Required). An instance of siamcat-class that contains trained models
`verbose` | integer, if the slot is empty, should a message be printed? values can be either `0` (no output) or `1` (print message)

### Details

The function will return a list containing the information stored in the `model_list` slot of a SIAMCAT object. This list contains:

- `models` - list of trained models

- `model_type` - machine learning method used for training

- `feature_type` - string describing on which type of features the models were trained

### Value

The list stored in the `model_list` slot of the SIAMCAT object or `NULL`

### Examples

    data(siamcat_example)
    temp <- model_list(siamcat_example)
    names(temp)

[Package SIAMCAT version 1.6.0 Index]