Attribute VB_Name = "eff_size_rosenthal"
'Created by Peter Stikker
'Companion website: https://PeterStatistics.com
'YouTube channel: https://www.youtube.com/stikpet
'Donations welcome at Patreon: https://www.patreon.com/bePatron?u=19398076

Public Sub es_rosenthal_addHelp()
Application.MacroOptions _
    Macro:="es_rosenthal", _
    Description:="Calculate a Rosenthal Correlation Coefficient", _
    category:=14, _
    ArgumentDescriptions:=Array( _
        "the z-value of test", _
        "the sample size", _
        "optional string for rule of thumb for qualification. See th_pearson_r for details", _
        "optional string, either " & Chr(34) & "value" & Chr(34) & " (default) for the eff. size value, or " & Chr(34) & "qual" & Chr(34) & " for the qualification")
        
Application.MacroOptions _
    Macro:="es_rosenthal_arr", _
    Description:="Calculate a Rosenthal Correlation Coefficient" & vbNewLine & "array function, requires 2 rows and 2 columns as output", _
    category:=14, _
    ArgumentDescriptions:=Array( _
        "the z-value of test", _
        "the sample size", _
        "optional string for rule of thumb for qualification. See th_pearson_r for details")
        
End Sub
Function es_rosenthal(zVal, n, Optional qual = "bartz", Optional out = "value")
'function to calculate a Rosenthal Correlation Coefficient
'zVal : z-value of test
'n : total sample size
'qual : optional string for rule of thumb for qualification. See th_pearson_r for details
'out : optional string, either "value" for the eff. size value, or "qual" for the qualification

r = zVal / Sqr(n)

'Results
If out = "value" Then
    res = r
Else
    'Qualification
    Dim qualification As String
    
    qualification = th_pearson_r(r, qual)
    
    res = qualification
End If

es_rosenthal = res

End Function


Function es_rosenthal_arr(zVal, n, Optional qual = "bartz")
'function to calculate a Rosenthal Correlation Coefficient
'zVal : z-value of test
'n : total sample size
'requires a 2 by 2 range for the output

r = zVal / Sqr(n)

'Qualification
qualification = th_pearson_r(r, qual)
    
'Results
Dim res(1 To 2, 1 To 2)
res(1, 1) = "Rosenthal Correlation"
res(1, 2) = "Qualification"
res(2, 1) = r
res(2, 2) = qualification
    
es_rosenthal_arr = res

End Function