speccurvieR (version 1.0.0)

sca_report: Write a results paragraph for a specification curve analysis

Description

`sca_report()` returns a one-paragraph, manuscript-ready description of a specification curve. For an [sca_test()] object it states the median estimate, the share of significant specifications, the joint-inference statistics with their permutation p-values, and (when the full set of statistics is available) whether the null of no effect is rejected. For an [sca()] curve it gives a purely descriptive summary.

Usage

sca_report(x, digits = 3, ...)

Value

A length-one character string.

Arguments

x

An object returned by [sca()] or [sca_test()].

digits

Number of significant digits for estimates. Defaults to `3`.

...

Ignored.

See Also

[sca_table()] for a tabular summary.

Examples

s <- sca(y = "Salnty", x = "T_degC", controls = c("ChlorA", "O2Sat"),
         data = bottles, progress_bar = FALSE, parallel = FALSE)
sca_report(s)
# \donttest{
result <- sca_test(y = "Salnty", x = "T_degC", controls = c("ChlorA", "O2Sat"),
                   data = bottles, n_permutations = 50, seed = 1,
                   progress_bar = FALSE)
sca_report(result)
# }