Skip to contents

ARD Dichotomous Survey Statistics

Source: R/ard_tabulate_value.survey.design.R
ard_tabulate_value.survey.design.Rd

Compute Analysis Results Data (ARD) for dichotomous summary statistics.

Usage 

# S3 method for class 'survey.design'
ard_tabulate_value(
  data,
  variables,
  by = NULL,
  value = cards::maximum_variable_value(data$variables[variables]),
  statistic = everything() ~ c("n", "N", "p", "p.std.error", "n_unweighted",
    "N_unweighted", "p_unweighted"),
  denominator = c("column", "row", "cell"),
  fmt_fun = NULL,
  stat_label = everything() ~ list(p = "%", p.std.error = "SE(%)", deff =
    "Design Effect", n_unweighted = "Unweighted n", N_unweighted = "Unweighted N",
    p_unweighted = "Unweighted %"),
  fmt_fn = deprecated(),
  ...
)

Arguments

data

(survey.design)
a design object often created with survey::svydesign().

variables

(tidy-select)
columns to include in summaries.

by

(tidy-select)
results are calculated for all combinations of the column specified and the variables. A single column may be specified.

value

(named list)
named list of dichotomous values to tabulate. Default is cards::maximum_variable_value(data$variables), which returns the largest/last value after a sort.

statistic

(formula-list-selector)
a named list, a list of formulas, or a single formula where the list element is a character vector of statistic names to include. See default value for options.

denominator

(string)
a string indicating the type proportions to calculate. Must be one of "column" (the default), "row", and "cell".

fmt_fun

(formula-list-selector)
a named list, a list of formulas, or a single formula where the list element is a named list of functions (or the RHS of a formula), e.g. list(mpg = list(mean = \(x) round(x, digits = 2) |> as.character())).

stat_label

(formula-list-selector)
a named list, a list of formulas, or a single formula where the list element is either a named list or a list of formulas defining the statistic labels, e.g. everything() ~ list(mean = "Mean", sd = "SD") or everything() ~ list(mean ~ "Mean", sd ~ "SD").

fmt_fn

[Deprecated]

...

These dots are for future extensions and must be empty.

Value

an ARD data frame of class 'card'

Examples 

survey::svydesign(ids = ~1, data = mtcars, weights = ~1) |>
  ard_tabulate_value(by = vs, variables = c(cyl, am), value = list(cyl = 4))
#> # An ARD data frame: 28 × 11
#>    group1 group1_level variable variable_level context     stat_name       stat
#>    <chr>        <list> <chr>            <list> <chr>       <chr>         <list>
#>  1 vs                0 cyl                   4 dichotomous n             1     
#>  2 vs                0 cyl                   4 dichotomous N            18     
#>  3 vs                0 cyl                   4 dichotomous p             0.0556
#>  4 vs                0 cyl                   4 dichotomous p.std.error   0.0549
#>  5 vs                0 am                    1 dichotomous n             6     
#>  6 vs                0 am                    1 dichotomous N            18     
#>  7 vs                0 am                    1 dichotomous p             0.333 
#>  8 vs                0 am                    1 dichotomous p.std.error   0.113 
#>  9 vs                0 cyl                   4 dichotomous n_unweighted  1     
#> 10 vs                0 cyl                   4 dichotomous N_unweighted 18     
#> # ℹ 18 more rows
#> # ℹ 4 more variables: stat_label <chr>, fmt_fun <list>, warning <list>,
#> #   error <list>