.check_input_identifier_column {familiar} | R Documentation |
Internal function for checking consistency of the identifier columns
Description
This function checks whether an identifier column is consistent, i.e. appears it exists, there is only one, and there is no overlap with any user-provided feature columns, identifiers, or
Usage
.check_input_identifier_column(
id_column,
data,
signature = NULL,
exclude_features = NULL,
include_features = NULL,
other_id_column = NULL,
outcome_column = NULL,
col_type,
check_stringency = "strict"
)
Arguments
id_column |
Character string indicating the currently inspected identifier column. |
data |
Data set as loaded using the |
signature |
(optional) One or more names of feature columns that are considered part of a specific signature. Features specified here will always be used for modelling. Ranking from feature selection has no effect for these features. |
exclude_features |
(optional) Feature columns that will be removed
from the data set. Cannot overlap with features in |
include_features |
(optional) Feature columns that are specifically
included in the data set. By default all features are included. Cannot
overlap with |
other_id_column |
Character string indicating another identifier column. |
outcome_column |
Character string indicating the outcome column(s). |
col_type |
Character string indicating the type of column, i.e. |
check_stringency |
Specifies stringency of various checks. This is mostly:
|