check_descriptors: Check available descriptors

In mmaitenat/ideafix: ideafix, DEAmination FIXing

Description

check_descriptors checks which variant descriptors are present in the input object variant_descriptors and decides if these are sufficient to be used with the model provided in algorithm.

Usage

check_descriptors(variant_descriptors, algorithm)

Arguments

variant_descriptors	tibble containing the variants to be classified together with their values for a series of descriptors obtained by get_descriptors.
algorithm	character string naming the algorithm to use to classify the variants. Can be "RF" or "XGBoost".

Details

check_descriptors checks if the descriptors present in variant_descriptors are sufficient to run the model in algorithm on them. If variant_descriptors object contains fewer descriptors than those included in the models and algorithm is "XGBoost", it throws an error message warning about the impossibility of executing the classification using that algorithm, and if the classification has been called, it stops. If algorithm equals to "RF" instead, a warning message alerts about this and the absence of performance guarantees, but the classification is executed if called.

Value

None

mmaitenat/ideafix documentation built on Sept. 18, 2021, 7:55 a.m.