ost: Generate Output for a One Sample t-Test

Description Usage Arguments Value Examples

View source: R/ost.R

Description

This function will generate the output for a one sample t test.

Usage

1
ost(x, y = NULL, tails = 2, mu = 0)

Arguments

x

a formula ~Dependent Variable (or DV~1) or a data frame column containing the Dependent Variable

y

optional, a data frame when data frame is not referenced and a formula is passed to x or piped in

tails

an integer indicating whether the test is one-tailed '1' or two-tailed '2'

mu

a double representing the value you want to comare to, the default for this parameter is 0.0

Value

A list of output for reporting $analysis_type, $results, $descriptive_statistics

Examples

1
2
3
4
ost_results <- idt_data %>% ost(~scones,mu = 44)
ost_results <- ost(idt_data$scones, tails = 1, mu = 44)
ost_results <- ost(idt_data$scones ~ 1, tails = 1, mu = 44)
ost_results <- ost(scones ~ 1, idt_data, tails = 1, mu = 44)

ECO230/eco230r documentation built on May 12, 2020, 2:10 a.m.