new_score_obj {filtro} | R Documentation |
Construct a new score object
Description
Create a new score object that contains associated metadata, such as range
,
fallback_value
, score_type
, direction
, and other relevant attributes.
Usage
new_score_obj(
subclass = c("cat_num", "cat_cat", "num_num", "any"),
outcome_type = c("numeric", "factor"),
predictor_type = c("numeric", "factor"),
case_weights = NULL,
range = NULL,
inclusive = NULL,
fallback_value = NULL,
score_type = NULL,
trans = NULL,
sorts = NULL,
direction = NULL,
deterministic = NULL,
tuning = NULL,
ties = NULL,
calculating_fn = NULL,
label = NULL,
...
)
Arguments
subclass |
A character string indicating the type of predictor-outcome combination the scoring method supports. One of:
|
outcome_type |
A character string indicating the outcome type. One of:
|
predictor_type |
A character string indicating the predictor type. One of:
|
case_weights |
A logical value, indicating whether the model accepts
case weights ( |
range |
A numeric vector of length two, specifying the minimum and maximum possible values, respectively. |
inclusive |
A logical vector of length two, indicating whether the lower and
upper bounds of the range are inclusive ( |
fallback_value |
A numeric scalar used as a fallback value. Typical values include:
|
score_type |
A character string indicating the type of scoring metric to compute. Available options include:
|
trans |
Currently not used. |
sorts |
An optional function used to sort the scores. Common options include:
|
direction |
A character string indicating the optimization direction. One of:
|
deterministic |
A logical value, indicating whether the score is
deterministic ( |
tuning |
A logical value, indicating whether the model should be tuned
( |
ties |
An optional logical value indicating whether ties in score can occur ( |
calculating_fn |
An optional function used to compute the score. A default function
is selected based on the |
label |
A named character string that can be used for printing and plotting. |
... |
Currently not used. |
Value
A score object.
Examples
# Create a score object
new_score_obj()