Skip to contents

Render stored descriptions or ask infercalcR to compute descriptions without hypothesis tests. Supplied inference is joined only by explicit stable identifiers.

Usage

report_descriptive(x, variables = NULL, group = NULL, labels = NULL,
  units = NULL, types = NULL, inference = NULL, mapping = NULL,
  inference_population = NULL, p = c("reported", "raw", "adjusted"),
  digits = 3L, p_digits = 3L, decimal_mark = ".")

Arguments

x

A raw data.frame or a finalized descriptive result.

variables

Selected raw-data column names, default all except the grouping variable.

group

An optional grouping column name.

labels, units

Optional vectors named by variable ID.

types

Named vector of continuous or categorical. Factors, including ordered factors, remain categorical by default.

inference

Optional finalized common result or list of results with distinct result IDs.

mapping

A data.frame with variable_id, result_id and row_id. At most one inference row per descriptive variable is supported. Every mapping entry must refer to an existing result and variable.

inference_population

Required nonempty label when inference is supplied, documenting its analysis population separately from descriptive denominators.

p

Which stored p-value to display.

digits, p_digits, decimal_mark

Display settings as in report_table.

Value

An ordinary data.frame with full-precision descriptions, n, n.missing, n.total, group/level labels and display columns. No p-value columns exist by default. Optional joined inference fields have an inference_ prefix. Metadata retains descriptive and inferential populations separately.

Details

The raw route delegates to infercalcR::describe_data. Categorical percentages use nonmissing denominators and missing groups remain explicit. No automatic hypothesis test is selected. The join never matches on display labels, and cannot infer that two differently labeled analysis populations are identical. Group-specific multiple tests per variable require separate explicitly scoped reports.

Examples

d <- data.frame(value = c(1, 2, NA, 4), group = c("A", "A", "B", "B"))
report_descriptive(d, group = "group", units = c(value = "mm"))
#>                row_id variable_id   component estimand  estimate n n.excluded
#> 1   description:1:1:1       value description     mean 1.5000000 2          0
#> 2   description:1:1:2       value description       sd 0.7071068 2          0
#> 3   description:1:1:3       value description   median 1.5000000 2          0
#> 4   description:1:1:4       value description       q1 1.2500000 2          0
#> 5   description:1:1:5       value description       q3 1.7500000 2          0
#> 6   description:1:1:6       value description      min 1.0000000 2          0
#> 7   description:1:1:7       value description      max 2.0000000 2          0
#> 8   description:1:2:8       value description     mean 4.0000000 1          0
#> 9   description:1:2:9       value description       sd        NA 1          0
#> 10 description:1:2:10       value description   median 4.0000000 1          0
#> 11 description:1:2:11       value description       q1 4.0000000 1          0
#> 12 description:1:2:12       value description       q3 4.0000000 1          0
#> 13 description:1:2:13       value description      min 4.0000000 1          0
#> 14 description:1:2:14       value description      max 4.0000000 1          0
#>       status                               reason group group_missing
#> 1         ok                                 <NA>     A         FALSE
#> 2         ok                                 <NA>     A         FALSE
#> 3         ok                                 <NA>     A         FALSE
#> 4         ok                                 <NA>     A         FALSE
#> 5         ok                                 <NA>     A         FALSE
#> 6         ok                                 <NA>     A         FALSE
#> 7         ok                                 <NA>     A         FALSE
#> 8         ok                                 <NA>     B         FALSE
#> 9  undefined insufficient nonmissing observations     B         FALSE
#> 10        ok                                 <NA>     B         FALSE
#> 11        ok                                 <NA>     B         FALSE
#> 12        ok                                 <NA>     B         FALSE
#> 13        ok                                 <NA>     B         FALSE
#> 14        ok                                 <NA>     B         FALSE
#>    variable_type label unit level proportion n.missing n.total contrast
#> 1     continuous value   mm  <NA>         NA         0       2     <NA>
#> 2     continuous value   mm  <NA>         NA         0       2     <NA>
#> 3     continuous value   mm  <NA>         NA         0       2     <NA>
#> 4     continuous value   mm  <NA>         NA         0       2     <NA>
#> 5     continuous value   mm  <NA>         NA         0       2     <NA>
#> 6     continuous value   mm  <NA>         NA         0       2     <NA>
#> 7     continuous value   mm  <NA>         NA         0       2     <NA>
#> 8     continuous value   mm  <NA>         NA         1       2     <NA>
#> 9     continuous value   mm  <NA>         NA         1       2     <NA>
#> 10    continuous value   mm  <NA>         NA         1       2     <NA>
#> 11    continuous value   mm  <NA>         NA         1       2     <NA>
#> 12    continuous value   mm  <NA>         NA         1       2     <NA>
#> 13    continuous value   mm  <NA>         NA         1       2     <NA>
#> 14    continuous value   mm  <NA>         NA         1       2     <NA>
#>    statistic df conf.low conf.high conf.level interval.method interval.scale
#> 1         NA NA       NA        NA         NA            <NA>           <NA>
#> 2         NA NA       NA        NA         NA            <NA>           <NA>
#> 3         NA NA       NA        NA         NA            <NA>           <NA>
#> 4         NA NA       NA        NA         NA            <NA>           <NA>
#> 5         NA NA       NA        NA         NA            <NA>           <NA>
#> 6         NA NA       NA        NA         NA            <NA>           <NA>
#> 7         NA NA       NA        NA         NA            <NA>           <NA>
#> 8         NA NA       NA        NA         NA            <NA>           <NA>
#> 9         NA NA       NA        NA         NA            <NA>           <NA>
#> 10        NA NA       NA        NA         NA            <NA>           <NA>
#> 11        NA NA       NA        NA         NA            <NA>           <NA>
#> 12        NA NA       NA        NA         NA            <NA>           <NA>
#> 13        NA NA       NA        NA         NA            <NA>           <NA>
#> 14        NA NA       NA        NA         NA            <NA>           <NA>
#>    interval.scope null.value alternative                  result_id
#> 1            <NA>         NA        <NA> descriptive_summary:result
#> 2            <NA>         NA        <NA> descriptive_summary:result
#> 3            <NA>         NA        <NA> descriptive_summary:result
#> 4            <NA>         NA        <NA> descriptive_summary:result
#> 5            <NA>         NA        <NA> descriptive_summary:result
#> 6            <NA>         NA        <NA> descriptive_summary:result
#> 7            <NA>         NA        <NA> descriptive_summary:result
#> 8            <NA>         NA        <NA> descriptive_summary:result
#> 9            <NA>         NA        <NA> descriptive_summary:result
#> 10           <NA>         NA        <NA> descriptive_summary:result
#> 11           <NA>         NA        <NA> descriptive_summary:result
#> 12           <NA>         NA        <NA> descriptive_summary:result
#> 13           <NA>         NA        <NA> descriptive_summary:result
#> 14           <NA>         NA        <NA> descriptive_summary:result
#>              method_id          variant_id estimate_display
#> 1  descriptive_summary descriptive_summary              1.5
#> 2  descriptive_summary descriptive_summary            0.707
#> 3  descriptive_summary descriptive_summary              1.5
#> 4  descriptive_summary descriptive_summary             1.25
#> 5  descriptive_summary descriptive_summary             1.75
#> 6  descriptive_summary descriptive_summary                1
#> 7  descriptive_summary descriptive_summary                2
#> 8  descriptive_summary descriptive_summary                4
#> 9  descriptive_summary descriptive_summary      unavailable
#> 10 descriptive_summary descriptive_summary                4
#> 11 descriptive_summary descriptive_summary                4
#> 12 descriptive_summary descriptive_summary                4
#> 13 descriptive_summary descriptive_summary                4
#> 14 descriptive_summary descriptive_summary                4
#>        interval_display statistic_display           confidence_display
#> 1  interval unavailable       unavailable confidence level unavailable
#> 2  interval unavailable       unavailable confidence level unavailable
#> 3  interval unavailable       unavailable confidence level unavailable
#> 4  interval unavailable       unavailable confidence level unavailable
#> 5  interval unavailable       unavailable confidence level unavailable
#> 6  interval unavailable       unavailable confidence level unavailable
#> 7  interval unavailable       unavailable confidence level unavailable
#> 8  interval unavailable       unavailable confidence level unavailable
#> 9  interval unavailable       unavailable confidence level unavailable
#> 10 interval unavailable       unavailable confidence level unavailable
#> 11 interval unavailable       unavailable confidence level unavailable
#> 12 interval unavailable       unavailable confidence level unavailable
#> 13 interval unavailable       unavailable confidence level unavailable
#> 14 interval unavailable       unavailable confidence level unavailable