R hardhat validate_outcomes_are_univariate 确保结果是单变量

验证 - 断言以下内容：

• outcomes 必须有 1 列。原子向量被视为 1 列矩阵。

检查 - 返回以下内容：

• ok 逻辑。检查通过吗？

• n_cols 单个数字。实际的列数。

用法

validate_outcomes_are_univariate(outcomes)

check_outcomes_are_univariate(outcomes)

参数

outcomes

要检查的对象。

值

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

check_outcomes_are_univariate() 返回两个组件的命名列表： ok 和 n_cols 。

细节

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

验证

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

• check_*() ：检查条件，并返回列表。该列表始终包含至少一个元素 ok ，这是一个指定检查是否通过的逻辑。每个检查还在返回的列表中检查特定元素，可用于构造有意义的错误消息。

• validate_*()：检查条件，如果不通过则出错。这些函数调用相应的检查函数，然后提供默认的错误消息。如果您作为开发人员想要不同的错误消息，请自行调用 check_*() 函数，并提供您自己的验证函数。

也可以看看

例子

validate_outcomes_are_univariate(data.frame(x = 1))

try(validate_outcomes_are_univariate(mtcars))
#> Error in validate_outcomes_are_univariate(mtcars) : 
#>   The outcome must be univariate, but 11 columns were found.