validate.data {SIAMCAT}R Documentation

Validate samples in labels, features, and metadata

Description

This function checks if labels are available for all samples in features. Additionally validates metadata, if available.

Usage

validate.data(siamcat, verbose = 1)

Arguments

siamcat

an object of class siamcat-class

verbose

control output: 0 for no output at all, 1 for only information about progress and success, 2 for normal level of information and 3 for full debug information, defaults to 1

Details

This function validates the data by checking that labels are available for all samples in the feature matrix. Furthermore, the number of samples per class is checked to ensure a minimum number. If metadata is available, the overlap between labels and metadata is checked as well.

Value

an object of class siamcat-class with validated data

Examples


    data(siamcat_example)
    # simple working example
    siamcat_validated <- validate.data(siamcat_example)


[Package SIAMCAT version 1.0.0 Index]