average_correlations: Average Correlations with Fisher's R to Z conversion

View source: R/average_correlations.R

average_correlationsR Documentation

Average Correlations with Fisher's R to Z conversion

Description

This function will take as input a verctor of correlations and output their mean after being transformed to fisher's Zs and back

Usage

average_correlations(correlations, ns, na.rm = T, use_weights = F)

Arguments

correlations

The vector of correlations to average

Details

see https://www.tandfonline.com/doi/pdf/10.1080/00221309809595548?needAccess=true

Value

float: Average of correlations

Examples

c(.40, .04, .23, .25, .94, .01) |> average_correlations()
c(.40, .04, .23, .25, .94, .01) |> average_correlations(ns = c(10, 20, 40, 23, 10, 123))
c(.40, .04, .23, .25, .94, .01) |> average_correlations(ns = c(10, 20, 40, 23, 10, 123), use_weights = F)
c(.40, .04, .23, .25, .94, .01) |> average_correlations(ns = c(10, 20, 40, 23, 10, 123), use_weights = T)

lirabenjamin/Ben documentation built on Aug. 6, 2024, 7:11 p.m.