View source: R/one-sample-test.R
| one_sample_test | R Documentation |
Parametric, non-parametric, robust, and Bayesian one-sample tests.
one_sample_test(
data,
x,
type = "parametric",
test.value = 0,
alternative = "two.sided",
digits = 2L,
conf.level = 0.95,
tr = 0.2,
bf.prior = 0.707,
effsize.type = "g",
exact = FALSE,
...
)
data |
A data frame (or a tibble) from which variables specified are to
be taken. Other data types (e.g., matrix, table, array, etc.) will not
be accepted. Additionally, grouped data frames from |
x |
A numeric variable from the data frame |
type |
A character specifying the type of statistical approach:
You can specify just the initial letter (e.g. |
test.value |
A number indicating the true value of the mean (Default:
|
alternative |
a character string specifying the alternative
hypothesis, must be one of |
digits |
Number of digits for rounding or significant figures. May also
be |
conf.level |
Scalar between |
tr |
Trim level for the mean when carrying out |
bf.prior |
A number between |
effsize.type |
Type of effect size needed for parametric tests. The
argument can be |
exact |
A logical indicating whether you want exact p-values to be computed.
Relevant only when |
... |
Currently ignored. |
The returned object is a tibble data frame with the additional class
"statsExpressions". The exact set of columns depends on the test and, for
functions that accept a type argument, on the chosen analysis (parametric,
non-parametric, robust, or Bayesian). Any given call therefore returns some
(not all) of the columns below.
Hypothesis testing
statistic: the numeric value of a statistic
df: the numeric value of a parameter being modeled (often degrees
of freedom for the test)
df.error and df: relevant only if the statistic in question has
two degrees of freedom (e.g. anova)
p.value: the p-value associated with the observed statistic (two-sided
unless a one-sided alternative is requested, where supported)
method: the name of the inferential statistical test
Effect size estimation
effectsize: the name of the effect size
estimate: estimated value of the effect size
conf.level: the coverage level of the confidence/credible interval
(e.g. 0.95); the interval itself spans conf.low to conf.high
conf.low: lower bound for the effect size estimate
conf.high: upper bound for the effect size estimate
conf.method: method used to compute the confidence/credible interval
conf.distribution: statistical distribution for the effect
Bayesian analysis (only when type = "bayes")
bf10: Bayes factor for the alternative hypothesis relative to the null
log_e_bf10: natural logarithm of the Bayes factor (present for most, but
not all, Bayesian analyses)
prior.distribution, prior.scale, prior.location: prior specification
used to compute the Bayes factor and posterior estimates
Pairwise comparisons (for pairwise_comparisons() and
pairwise_contingency_table())
group1, group2: the two levels being compared
p.adjust.method: the adjustment method used for multiple comparisons
p.value.adj: the adjusted p-value; returned by
pairwise_contingency_table(). Note that pairwise_comparisons() instead
folds the adjusted value into p.value (and does not return a separate
p.value.adj column)
Common columns
n.obs: number of observations
expression: a list-column of pre-formatted
plotmath expressions; each
element is a language object (not a character string) containing the
statistical details, ready to be used in {ggplot2} (e.g. in labs() or
annotate())
For a per-function, column-by-column breakdown of the output (and an explanation
of the internal add_expression_col() engine that builds the expression
column), see the Return value schema
article. For more examples, see the data frame output vignette.
The table below provides summary about:
statistical test carried out for inferential statistics
type of effect size estimate and a measure of uncertainty for this estimate
functions used internally to compute these details
Hypothesis testing
| Type | Test | Function used |
| Parametric | One-sample Student's t-test | stats::t.test() |
| Non-parametric | One-sample Wilcoxon test | stats::wilcox.test() |
| Robust | Bootstrap-t method for one-sample test | WRS2::trimcibt() |
| Bayesian | One-sample Student's t-test | BayesFactor::ttestBF() |
Effect size estimation
| Type | Effect size | CI available? | Function used |
| Parametric | Cohen's d, Hedge's g | Yes | effectsize::cohens_d(), effectsize::hedges_g() |
| Non-parametric | r (rank-biserial correlation) | Yes | effectsize::rank_biserial() |
| Robust | trimmed mean | Yes | WRS2::trimcibt() |
| Bayesian | difference | Yes | bayestestR::describe_posterior() |
Patil, I., (2021). statsExpressions: R Package for Tidy Dataframes and Expressions with Statistical Details. Journal of Open Source Software, 6(61), 3236, https://doi.org/10.21105/joss.03236
# for reproducibility
set.seed(123)
# ----------------------- parametric -----------------------
one_sample_test(mtcars, wt, test.value = 3)
# biased (Cohen's d) effect size
one_sample_test(mtcars, wt, test.value = 3, effsize.type = "d")
# ----------------------- non-parametric -------------------
one_sample_test(mtcars, wt, test.value = 3, type = "nonparametric")
# ----------------------- robust ---------------------------
one_sample_test(mtcars, wt, test.value = 3, type = "robust")
# ----------------------- Bayesian -------------------------
one_sample_test(mtcars, wt, test.value = 3, type = "bayes")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.