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.