TOSTt-methods {TOSTER}R Documentation

Methods for TOSTt objects

Description

Methods defined for objects returned from the t_TOST and boot_t_TOST functions.

Usage

## S3 method for class 'TOSTt'
print(x, digits = 4, ...)

## S3 method for class 'TOSTt'
plot(
  x,
  type = c("cd", "c", "tnull"),
  estimates = c("raw", "SMD"),
  ci_lines,
  ci_shades,
  ...
)

describe(x, ...)

## S3 method for class 'TOSTt'
describe(x, digits = 3, ...)

Arguments

x

object of class TOSTt

digits

Number of digits to print for p-values

...

further arguments passed through, see description of return value for details. TOSTt-methods.

type

Type of plot to produce. Default is a consonance density plot "cd". Consonance plots (type = "cd") and null distribution plots (type = "tnull") can also be produced. Note: null distribution plots only available for estimates = "raw".

estimates

indicator of what estimates to plot; options include "raw" or "SMD". Default is is both: c("raw","SMD").

ci_lines

Confidence interval lines for plots. Default is 1-alpha*2 (e.g., alpha = 0.05 is 90%)

ci_shades

Confidence interval shades when plot type is "cd".

Value

print

Prints short summary of the tests.

plot

Returns a plot of the effects.

describe

Verbose description of results.

Examples

# example code
# Print

res1 = t_TOST(mpg ~ am, data = mtcars, eqb = 3)

res1
# Print with more digits
print(res1, digits = 6)
## Not run: 
# Plot with density plot - only raw values (SLOW)
plot(res1, type = "cd", estimates = "raw")
# Plot with consonance - only raw values (SLOW)
plot(res1, type = "c", estimates = "raw")
# Plot null distribution - only raw values
plot(res1, type = "tnull", estimates = "raw")

## End(Not run)
# Get description of the results
describe(res1)


[Package TOSTER version 0.7.1 Index]