as_cards_fn {cards} | R Documentation |
As card function
Description
Add attributes to a function that specify the expected results.
It is used when ard_continuous()
or ard_complex()
errors and constructs
an ARD with the correct structure when the results cannot be calculated.
Usage
as_cards_fn(f, stat_names)
is_cards_fn(f)
get_cards_fn_stat_names(f)
Arguments
f |
( |
stat_names |
( |
Value
an ARD data frame of class 'card'
Examples
# When there is no error, everything works as if we hadn't used `as_card_fn()`
ttest_works <-
as_cards_fn(
\(x) t.test(x)[c("statistic", "p.value")],
stat_names = c("statistic", "p.value")
)
ard_continuous(
mtcars,
variables = mpg,
statistic = ~ list(ttest = ttest_works)
)
# When there is an error and we use `as_card_fn()`,
# we will see the same structure as when there is no error
ttest_error <-
as_cards_fn(
\(x) {
t.test(x)[c("statistic", "p.value")]
stop("Intentional Error")
},
stat_names = c("statistic", "p.value")
)
ard_continuous(
mtcars,
variables = mpg,
statistic = ~ list(ttest = ttest_error)
)
# if we don't use `as_card_fn()` and there is an error,
# the returned result is only one row
ard_continuous(
mtcars,
variables = mpg,
statistic = ~ list(ttest = \(x) {
t.test(x)[c("statistic", "p.value")]
stop("Intentional Error")
})
)
[Package cards version 0.6.1 Index]