bcor.testSumStat: Summary stats version of "bcor.test()"

View source: R/mainWrappers.R

bcor.testSumStatR Documentation

Summary stats version of "bcor.test()"

Description

Summary stats version of "bcor.test()"

Usage

bcor.testSumStat(
  n,
  stat,
  alternative = c("two.sided", "less", "greater"),
  method = c("pearson", "kendall", "spearman"),
  ciValue = 0.95,
  h0 = 0,
  kappa = 1,
  hyperGeoOverFlowThreshold = 25,
  oneThreshold = 0.001,
  var = 1,
  k = 0
)

Arguments

n

number of observations

stat

sample correlation coefficient

alternative

indicates the alternative hypothesis and must be one of "two.sided", "greater" or "less". "greater" corresponds to positive association, "less" to negative association.

method

a character string indicating which correlation coefficient is to b used for the test. One of "pearson", "kendall" or "spearman".

ciValue

numeric in (0, 1) credible level for the returned credible interval.

h0

numeric between -1 and 1 that specifies the point null hypothesis

kappa

numeric > 0 that specifies the

hyperGeoOverFlowThreshold

numeric > 0 such that if log(bf10) > hyperGeoOverFlowThreshold then the Savage-Dickey adaptation is used for to compute the one-sided Bayes factors, instead of the analytical ones.

oneThreshold

numeric > 0 such that if abs(1 - stat) < oneThreshold, then abs(stat) is viewed as one.

var

numeric > 0 that specifies the asymptotic variance of the approximate likelihood for Kendall's tau

k

number of controlling variables

Value

A list with class "btest" containing the following components:

Examples

bcor.testSumStat(n=34, stat=0.4)
bcor.testSumStat(n=34, stat=0.4, method="kendall")
bcor.testSumStat(n=34, stat=0.45, k = 1)

AlexanderLyNL/bstats documentation built on Sept. 11, 2023, 4:10 p.m.