R hardhat validate_outcomes_are_binary 确保结果具有二元因子

验证 - 断言以下内容：

outcomes 必须具有二进制因子列。

检查 - 返回以下内容：

ok 逻辑。检查通过吗？
bad_cols 字符向量。有问题的列的名称。
num_levels 整数向量。有问题的列的实际级别数。

用法

validate_outcomes_are_binary(outcomes)

check_outcomes_are_binary(outcomes)

参数

outcomes: 要检查的对象。

值

validate_outcomes_are_binary() 以不可见方式返回outcomes。

check_outcomes_are_binary() 返回三个组件的命名列表： ok 、 bad_cols 和 num_levels 。

细节

使用此验证函数的预期方法是向其提供 mold() 调用结果的 $outcomes 元素。

验证

Hardhat 提供两个级别的验证函数。

check_*() ：检查条件，并返回列表。该列表始终包含至少一个元素 ok ，这是一个指定检查是否通过的逻辑。每个检查还在返回的列表中检查特定元素，可用于构造有意义的错误消息。
validate_*()：检查条件，如果不通过则出错。这些函数调用相应的检查函数，然后提供默认的错误消息。如果您作为开发人员想要不同的错误消息，请自行调用 check_*() 函数，并提供您自己的验证函数。

也可以看看

其他验证函数：validate_column_names()、validate_no_formula_duplication()、validate_outcomes_are_factors()、validate_outcomes_are_numeric()、validate_outcomes_are_univariate()、validate_prediction_size()、validate_predictors_are_numeric()

例子

# Not a binary factor. 0 levels
check_outcomes_are_binary(data.frame(x = 1))
#> $ok
#> [1] FALSE
#> 
#> $bad_cols
#> [1] "x"
#> 
#> $num_levels
#> [1] 0
#> 

# Not a binary factor. 1 level
check_outcomes_are_binary(data.frame(x = factor("A")))
#> $ok
#> [1] FALSE
#> 
#> $bad_cols
#> [1] "x"
#> 
#> $num_levels
#> [1] 1
#> 

# All good
check_outcomes_are_binary(data.frame(x = factor(c("A", "B"))))
#> $ok
#> [1] TRUE
#> 
#> $bad_cols
#> character(0)
#> 
#> $num_levels
#> integer(0)
#>

源代码：R/validation.R

相关用法

注：本文由纯净天空筛选整理自Davis Vaughan等大神的英文原创作品 Ensure that the outcome has binary factors。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。