
Compute effect sizes from reported study statistics
compute_es.RdComputes continuous, correlation, binary, proportion and ratio effect sizes
from explicitly selected reported statistics. This release supports only the routes listed
by es_methods(). No automatic selection among competing statistics occurs.
Usage
compute_es(
data,
measure = "SMD",
design,
input,
m1 = NULL,
sd1 = NULL,
n1 = NULL,
m2 = NULL,
sd2 = NULL,
n2 = NULL,
t = NULL,
f = NULL,
df = NULL,
df1 = NULL,
p = NULL,
effect_sign = NULL,
correction = c("hedges_exact", "hedges_approx", "none"),
variance_method = c("LS", "J2_LS"),
conf_level = 0.95,
study_id = NULL,
effect_id = NULL,
errors = c("collect", "stop"),
se1 = NULL,
se2 = NULL,
se_type = NULL,
lower1 = NULL,
upper1 = NULL,
lower2 = NULL,
upper2 = NULL,
ci_level1 = NULL,
ci_level2 = NULL,
ci_method = NULL,
ci_tolerance = 1e-08,
sd_total = NULL,
total_sd_scope = NULL,
reference_group = NULL,
r = NULL,
n_total = NULL,
predictors = NULL,
r_squared = NULL,
events1 = NULL,
non_events1 = NULL,
events2 = NULL,
non_events2 = NULL,
events = NULL,
person_time1 = NULL,
person_time2 = NULL,
zero_cell = NULL,
estimate = NULL,
estimate_se = NULL,
adjustment = NULL,
r_digits = NULL,
r_squared_digits = NULL
)
# S3 method for class 'mars_es'
print(x, ...)
# S3 method for class 'mars_es'
as.data.frame(x, row.names = NULL, optional = FALSE, ...)Arguments
- data
A data frame. Its row order is preserved; the original data are retained separately in
original_datawithout overwriting any columns.- measure
Target measure:
"SMD"(pooled-SD d/g),"MD"(raw mean difference), or"GLASS"(reference-arm SD standardization). May identify a column for row-specific measures. MD/GLASS support means_sd, means_se and means_ci; test-statistic and combined-SD routes remain SMD-only. Other measures: COR/ZCOR (Pearson r/Fisher z), PCOR/ZPCOR (partial), SPCOR/ZSPCOR (semipartial), OR/RR (log odds/risk ratios), RD (risk difference), PR/PLO/PLN (raw/logit/log proportion), IRR (log incidence rate ratio), ROM (log response ratio), HR (reported log hazard ratio).- design
Required design: independent_groups for group contrasts, independent_observations for COR/ZCOR, ordinary_regression for partial/ semipartial correlations, single_group for proportions, survival for HR. May identify a data column; unsupported designs receive diagnostics.
- input
Required route:
"means_sd","student_t","anova_f", or"p_value","means_se","means_ci", or"means_total_sd". May identify a column containing row-specific route names. Other families use correlation, regression_t, binary_counts, proportion_counts, incidence_counts, or reported_log_se. ROM supports means_sd/means_se/means_ci. See es_methods().- m1, sd1, n1, m2, sd2, n2
Group means, SDs and sample sizes, with group 1 minus group 2 defining the effect direction. Supply unquoted/quoted column names, numeric vectors of length
nrow(data), or scalar constants. Only the selected route's statistics are used for each row. Sample sizes must be integers > 1; SDs nonnegative; SMD requires positive pooled SD and GLASS positive reference SD.- t
Signed pooled Student t for input=student_t, or ordinary OLS focal coefficient t for input=regression_t. Welch, paired, robust and clustered tests are ineligible; only regression_t allows covariate adjustment.
- f
Nonnegative F statistic from a two-group unadjusted one-way ANOVA.
- df
Residual degrees of freedom for test-statistic routes. Must equal \(n_1+n_2-2\) for pooled tests or \(n_{\mathrm{total}}-k-1\) for
regression_t, wherepredictorsgives the number of slopes \(k\). For continuous summary-statistic routes, df is inferred from sample sizes.- df1
Numerator degrees of freedom for F, which must equal 1.
- p
Exact two-sided p-value from the eligible Student t test, in
(0,1]. Rounded zero, inequalities such as"<.05", and one-sided p-values must not be entered as exact two-sided probabilities.- effect_sign
Direction (
-1or1) required for unsigned F and p routes.- correction
"hedges_exact","hedges_approx", or"none". When omitted, SMD/GLASS use hedges_exact and all other measures use none. Explicit Hedges correction for MD is rejected. GLASS uses reference-arm \(\mathrm{df}=n_r-1\), where \(n_r\) is the reference-arm sample size.- variance_method
"JOINT_DELTA"is available for SMD/GLASS from separate arm SDs, SEs or CIs. It uses joint normal-summary delta variances compatible withcompute_es_covariance(). Existing defaults are unchanged. For SMD,"LS"(default) uses \(1/n_1+1/n_2+y_i^2/[2(n_1+n_2)]\)."J2_LS"uses \(J^2[1/n_1+1/n_2+d^2/[2(n_1+n_2)]]\). Both are approximations; their names and the correction are retained in the result. MD uses LS: \(s_1^2/n_1+s_2^2/n_2\), allowing unequal population variances. GLASS defaults to HET (metafor SMD1H convention); explicit LS/J2_LS assume equal population variances. All other families currently use LS only. See Details and the installed family specification for formulas.- conf_level
Confidence level for normal-approximation Wald intervals.
- study_id
Optional study identifiers. These do not assert independence between multiple effects sharing a study.
- effect_id
Optional unique, nonmissing effect identifiers. Defaults to sequential row identifiers.
- errors
"collect"preserves invalid rows with missing estimates and explicit status/messages;"stop"fails if any row lacks a complete result. With residual df <= 2, the point estimate is retained but variance and intervals are unavailable: the normal-theory SMD has no finite variance.- se1, se2
SEs of individual arm means for
means_se.- se_type
Required for
means_se:"unadjusted_mean". Contrast SEs, adjusted means, and cluster-based SEs are not eligible.- lower1, upper1, lower2, upper2
Confidence limits for the individual arm means.
- ci_level1, ci_level2
Reported arm-mean confidence levels, each strictly between zero and one. These are distinct from the output
conf_level.- ci_method
Required for
means_ci:"student_t", meaning unadjusted, two-sided arm-mean intervals using \(\mathrm{df}_i=n_i-1\). Other constructions are rejected.- ci_tolerance
Allowed midpoint error as a fraction of the interval's half-width (default 1e-8), plus machine-roundoff allowance. Set explicitly for rounded reports; must be in [0,1). The reported mean is never replaced.
- sd_total
Sample SD across both groups combined, including between-group variation. This is not the within-group pooled SD.
- total_sd_scope
Required for
means_total_sd:"two_groups", declaring that sd_total covers exactly the two groups at the same outcome/time.- reference_group
Required for GLASS: numeric 1 or 2, identifying the arm whose SD defines the standardizer. May be a column or row-specific vector. This choice does not change the group1-minus-group2 numerator.
- r
Reported Pearson, partial or semipartial correlation, according to measure. Fisher transformation is selected through the Z-prefixed measure.
- n_total
Total observation count for correlations or single proportions.
- predictors
Total regression slopes, including the focal predictor and controls, excluding the intercept. Must be an integer >= 1. Residual df is \(n_{\mathrm{total}}-k-1\) for \(k\) slopes. The
regression_troute requires this df explicitly.- r_squared
Full-model, unadjusted R-squared in [0,1), required for semipartial correlations and their variances. It must be at least \(r^2\).
- events1, non_events1, events2, non_events2
Nonnegative integer binomial cells. Each arm must have a positive total. Ratios contrast group 1 with group 2. events1/events2 also supply incidence counts for IRR.
- events
Nonnegative integer events for a single proportion.
- person_time1, person_time2
Positive exposures in comparable units for independent Poisson incidence counts; required for IRR.
- zero_cell
Required for count routes: none or add_half. add_half adds 0.5 to all four binomial cells if any is zero, both proportion cells at a boundary, or both incidence counts if one is zero (exposure unchanged). RD and PR require none. Both-zero event comparisons remain unavailable for ratios; OR also excludes both-all-event comparisons. No rows are dropped.
- estimate, estimate_se
Reported log hazard ratio and its positive SE on the log scale. A raw HR must first be logged; its raw-scale SE is ineligible.
- adjustment
Required for HR: adjusted or unadjusted. The original data should retain the adjustment variables and model details for comparability.
- r_digits, r_squared_digits
Optional decimal reporting precision (integer 0 through 15) for directly reported semipartial r and R-squared. Nearest- rounding intervals distinguish contradictory inputs from rounding ambiguity. Compatible but inconsistent reported points receive rounding_ambiguous: the point is retained but variance is withheld; no value is clipped or replaced.
- x
A
mars_esresult.- ...
Additional arguments passed to the data-frame print method.
- row.names, optional
Passed to the data-frame conversion method.
Value
A mars_es list with data (one result row per input row),
original_data, normalized inputs, provenance, assumptions,
reconstruction (recovered SEs/SDs and numerical notes), diagnostics, the formula
display (back-transformed estimates/limits, scale labels and separate
display diagnostics; no transformed variances), inference_notes (cautions
that do not exclude rows or change their analysis status),
registry, settings, and sampling_covariance = NULL. NULL means that
cross-effect covariance was not computed, not that it is zero.
Details
Provenance includes variance_formula and variance_basis. Small effective samples (<30) and sparse cells (<5) generate inference notes as screening heuristics, not validated pass/fail cutoffs. Semipartial results always note their distinct random-X sampling assumptions. These notes do not improve interval coverage or justify filtering studies with unavailable variances.
transform_es() provides explicit first-order delta propagation, including
full supplied covariance matrices. The original results are preserved.
The exact Hedges correction is
\(J=\Gamma(\nu/2)/(\sqrt{\nu/2}\Gamma((\nu-1)/2))\),
with \(\nu=n_1+n_2-2\). Its approximation is \(1-3/(4\nu-1)\).
\(y_i=Jd\), with \(J=1\) for Cohen's \(d\). Normality and common population variance
underlie this correction's usual unbiasedness interpretation. An exact bias
correction does not make the variance or confidence interval exact.
For GLASS let \(r\) denote the reference arm and \(o\) the other arm. Here \(\nu=n_r-1\) and \(d=(m_1-m_2)/s_r\). HET uses \(v=(s_o/s_r)^2/(n_o-1)+1/(n_r-1)+y_i^2/[2(n_r-1)]\). LS uses \(1/n_1+1/n_2+y_i^2/(2n_r)\); J2_LS uses \(J^2[1/n_1+1/n_2+d^2/(2n_r)]\). These are named approximations, matching metafor SMD1H and SMD1 LS/LS2 respectively; HET permits unequal variances. At reference df <= 1 corrected GLASS is unavailable (raw d retained); at reference df <= 2 no GLASS variance or interval is returned. All output intervals use normal Wald quantiles, including MD; they are not Welch-t or exact intervals. Zero estimated MD variance is diagnosed rather than supplied as a usable inverse-variance weight. MD's d and df are NA. For JOINT_DELTA, let \(q=\sum_i w_i s_i^2\). SMD uses \(w_i=(n_i-1)/(n_1+n_2-2)\); GLASS puts weight 1 on the reference arm. With \(y_i=J(m_1-m_2)/\sqrt{q}\), the implemented variance is $$v=J^2(s_1^2/n_1+s_2^2/n_2)/q +y_i^2\sum_h w_h^2 s_h^4/(n_h-1)/(2q^2).$$ This plug-in first-order approximation treats the sample sizes and correction J as fixed and accounts for uncertainty in the standardizer. It assumes independent normal arms and does not require equal observed SDs. It differs from LS, J2_LS and HET and is never selected automatically. Full formulas are installed in compute-es/COVARIANCE.md. Per-row correction and variance choices are recorded in data and provenance; settings records the call-level choices and whether defaults were used.
COR uses \(v=(1-r^2)^2/(n-1)\), and ZCOR uses \(1/(n-3)\). With \(k\) total slopes, PCOR uses \((1-r^2)^2/(n-k)\) and ZPCOR uses \(1/(n-k-2)\). SPCOR uses the variance $$v=[(1-R^2)^2+(R^2-r^2)(1-R^2+r^2)]/n.$$ ZSPCOR divides this variance by \((1-r^2)^2\). Fisher z is not variance stabilizing for semipartial correlations. Regression t reconstruction requires ordinary OLS with an intercept, not robust, clustered, weighted or generalized-model t statistics.
OR, RR, IRR, ROM and HR return log-scale yi/vi. PR, PLO and PLN use raw, logit and log probability scales respectively. See display for transformed interpretation; analyze data$yi with data$vi, never pair display estimates with analysis-scale variances. Wald limits on bounded raw scales are not clipped and can exceed the parameter bounds. Sparse-data approximations can be poor; zero estimated variance is diagnosed, not used as infinite precision. The full formulas, assumptions and boundary policies are installed in compute-es/FAMILIES.md. These routes do not establish complete Appendix B coverage, and do not estimate cross-effect sampling covariance.
This interface does not pool estimates or convert paired/adjusted effects to unadjusted SMDs. Inspect diagnostics before selecting rows for analysis. Other supplied statistics are preserved but do not override the explicitly chosen route. No dependency on metafor is required for computation.
References
Hedges, L. V. (1981). Distribution theory for Glass's estimator of effect size and related estimators. Journal of Educational Statistics, 6, 107-128. doi:10.3102/10769986006002107 .
Lipsey, M. W. and Wilson, D. B. (2001). Practical Meta-Analysis. Sage. Appendix B. This release implements selected route families, not the complete appendix.
Aloe, A. M., and Becker, B. J. (2012). An Effect Size for Regression Predictors in Meta-Analysis. Journal of Educational and Behavioral Statistics, 37(2), 278–297. doi:10.3102/1076998610396901 .
Aloe, A. M., and Thompson, C. G. (2013). The Synthesis of Partial Effect Sizes. Journal of the Society for Social Work and Research, 4(4), 390–405. doi:10.5243/jsswr.2013.24 .
Aloe, A. M. (2014). An Empirical Investigation of Partial Effect Sizes in Meta-Analysis of Correlational Data. The Journal of General Psychology, 141(1), 47–64. doi:10.1080/00221309.2013.853021 .
Hedges, L. V., Gurevitch, J., and Curtis, P. S. (1999). The Meta-Analysis of Response Ratios in Experimental Ecology. Ecology, 80(4), 1150–1156. doi:10.1890/0012-9658(1999)080[1150:TMAORR]2.0.CO;2 .
Lajeunesse, M. J. (2011). On the Meta-Analysis of Response Ratios for Studies with Correlated and Multi-Group Designs. Ecology, 92(11), 2049–2055. doi:10.1890/11-0423.1 .
Examples
dat <- data.frame(mt=12, st=3, nt=30, mc=10, sc=3, nc=30)
es <- compute_es(dat, design="independent_groups", input="means_sd",
m1=mt, sd1=st, n1=nt, m2=mc, sd2=sc, n2=nc)
es$data
#> effect_id study_id yi vi sei ci_lb ci_ub
#> 1 1 <NA> 0.6580024 0.07027473 0.2650938 0.1384281 1.177577
#> d J df status message measure design input
#> 1 0.6666667 0.9870036 58 ok SMD independent_groups means_sd
#> correction variance_method metric scale
#> 1 hedges_exact LS hedges_g standardized_mean_difference
es_methods()
#> route_id input measure design
#> 1 smd.means_sd.v1 means_sd SMD independent_groups
#> 2 smd.student_t.v1 student_t SMD independent_groups
#> 3 smd.anova_f.v1 anova_f SMD independent_groups
#> 4 smd.p_value.v1 p_value SMD independent_groups
#> 5 smd.means_se.v1 means_se SMD independent_groups
#> 6 smd.means_ci.v1 means_ci SMD independent_groups
#> 7 smd.means_total_sd.v1 means_total_sd SMD independent_groups
#> 8 md.means_sd.v1 means_sd MD independent_groups
#> 9 md.means_se.v1 means_se MD independent_groups
#> 10 md.means_ci.v1 means_ci MD independent_groups
#> 11 glass.means_sd.v1 means_sd GLASS independent_groups
#> 12 glass.means_se.v1 means_se GLASS independent_groups
#> 13 glass.means_ci.v1 means_ci GLASS independent_groups
#> 14 cor.correlation.v1 correlation COR independent_observations
#> 15 zcor.correlation.v1 correlation ZCOR independent_observations
#> 16 pcor.correlation.v1 correlation PCOR ordinary_regression
#> 17 pcor.regression_t.v1 regression_t PCOR ordinary_regression
#> 18 zpcor.correlation.v1 correlation ZPCOR ordinary_regression
#> 19 zpcor.regression_t.v1 regression_t ZPCOR ordinary_regression
#> 20 spcor.correlation.v1 correlation SPCOR ordinary_regression
#> 21 spcor.regression_t.v1 regression_t SPCOR ordinary_regression
#> 22 zspcor.correlation.v1 correlation ZSPCOR ordinary_regression
#> 23 zspcor.regression_t.v1 regression_t ZSPCOR ordinary_regression
#> 24 or.binary_counts.v1 binary_counts OR independent_groups
#> 25 rr.binary_counts.v1 binary_counts RR independent_groups
#> 26 rd.binary_counts.v1 binary_counts RD independent_groups
#> 27 pr.proportion_counts.v1 proportion_counts PR single_group
#> 28 plo.proportion_counts.v1 proportion_counts PLO single_group
#> 29 pln.proportion_counts.v1 proportion_counts PLN single_group
#> 30 irr.incidence_counts.v1 incidence_counts IRR independent_groups
#> 31 rom.means_sd.v1 means_sd ROM independent_groups
#> 32 rom.means_se.v1 means_se ROM independent_groups
#> 33 rom.means_ci.v1 means_ci ROM independent_groups
#> 34 hr.reported_log_se.v1 reported_log_se HR survival
#> status
#> 1 implemented
#> 2 implemented
#> 3 implemented
#> 4 implemented
#> 5 implemented
#> 6 implemented
#> 7 implemented
#> 8 implemented
#> 9 implemented
#> 10 implemented
#> 11 implemented
#> 12 implemented
#> 13 implemented
#> 14 implemented
#> 15 implemented
#> 16 implemented
#> 17 implemented
#> 18 implemented
#> 19 implemented
#> 20 implemented
#> 21 implemented
#> 22 implemented
#> 23 implemented
#> 24 implemented
#> 25 implemented
#> 26 implemented
#> 27 implemented
#> 28 implemented
#> 29 implemented
#> 30 implemented
#> 31 implemented
#> 32 implemented
#> 33 implemented
#> 34 implemented
#> required
#> 1 m1, sd1, n1, m2, sd2, n2
#> 2 t, df, n1, n2
#> 3 f, df1, df, effect_sign, n1, n2
#> 4 p, df, effect_sign, n1, n2
#> 5 m1, se1, n1, m2, se2, n2, se_type
#> 6 m1, lower1, upper1, n1, m2, lower2, upper2, n2, ci_level1, ci_level2, ci_method
#> 7 m1, m2, n1, n2, sd_total, total_sd_scope
#> 8 m1, sd1, n1, m2, sd2, n2
#> 9 m1, se1, n1, m2, se2, n2, se_type
#> 10 m1, lower1, upper1, n1, m2, lower2, upper2, n2, ci_level1, ci_level2, ci_method
#> 11 m1, sd1, n1, m2, sd2, n2, reference_group
#> 12 m1, se1, n1, m2, se2, n2, se_type, reference_group
#> 13 m1, lower1, upper1, n1, m2, lower2, upper2, n2, ci_level1, ci_level2, ci_method, reference_group
#> 14 r, n_total
#> 15 r, n_total
#> 16 r, n_total, predictors
#> 17 t, df, n_total, predictors
#> 18 r, n_total, predictors
#> 19 t, df, n_total, predictors
#> 20 r, n_total, predictors, r_squared
#> 21 t, df, n_total, predictors, r_squared
#> 22 r, n_total, predictors, r_squared
#> 23 t, df, n_total, predictors, r_squared
#> 24 events1, non_events1, events2, non_events2, zero_cell
#> 25 events1, non_events1, events2, non_events2, zero_cell
#> 26 events1, non_events1, events2, non_events2, zero_cell
#> 27 events, n_total, zero_cell
#> 28 events, n_total, zero_cell
#> 29 events, n_total, zero_cell
#> 30 events1, events2, person_time1, person_time2, zero_cell
#> 31 m1, sd1, n1, m2, sd2, n2
#> 32 m1, se1, n1, m2, se2, n2, se_type
#> 33 m1, lower1, upper1, n1, m2, lower2, upper2, n2, ci_level1, ci_level2, ci_method
#> 34 estimate, estimate_se, adjustment
#> estimate_formula
#> 1 d=(m1-m2)/sqrt(((n1-1)*sd1^2+(n2-1)*sd2^2)/(n1+n2-2)); yi=J*d (J=1 for correction='none')
#> 2 d=t*sqrt(1/n1+1/n2); yi=J*d (J=1 for correction='none')
#> 3 d=effect_sign*sqrt(f)*sqrt(1/n1+1/n2); df1=1; yi=J*d (J=1 for correction='none')
#> 4 d=effect_sign*qt(p/2,df,lower.tail=FALSE)*sqrt(1/n1+1/n2); yi=J*d (J=1 for correction='none')
#> 5 sd_i=se_i*sqrt(n_i); then means_sd; yi=J*d (J=1 for correction='none')
#> 6 se_i=(upper_i-lower_i)/(2*qt((1+level_i)/2,n_i-1)); then means_se; yi=J*d (J=1 for correction='none')
#> 7 sp^2=((N-1)*sd_total^2-n1*n2/N*(m1-m2)^2)/(N-2); d=(m1-m2)/sp; yi=J*d (J=1 for correction='none')
#> 8 Reconstruct arm SDs if needed; yi=m1-m2; vi=sd1^2/n1+sd2^2/n2
#> 9 Reconstruct arm SDs if needed; yi=m1-m2; vi=sd1^2/n1+sd2^2/n2
#> 10 Reconstruct arm SDs if needed; yi=m1-m2; vi=sd1^2/n1+sd2^2/n2
#> 11 Reconstruct arm SDs if needed; d=(m1-m2)/sd_reference; yi=J(n_reference-1)*d
#> 12 Reconstruct arm SDs if needed; d=(m1-m2)/sd_reference; yi=J(n_reference-1)*d
#> 13 Reconstruct arm SDs if needed; d=(m1-m2)/sd_reference; yi=J(n_reference-1)*d
#> 14 yi=r
#> 15 yi=atanh(r)
#> 16 r=reported correlation; yi=r
#> 17 r=t/sqrt(t^2+n_total-predictors-1); yi=r
#> 18 r=reported correlation; yi=atanh(r)
#> 19 r=t/sqrt(t^2+n_total-predictors-1); yi=atanh(r)
#> 20 r=reported correlation; yi=r
#> 21 r=t*sqrt((1-r_squared)/(n_total-predictors-1)); yi=r
#> 22 r=reported correlation; yi=atanh(r)
#> 23 r=t*sqrt((1-r_squared)/(n_total-predictors-1)); yi=atanh(r)
#> 24 yi=log(a)-log(b)-log(c)+log(d)
#> 25 yi=log(a/(a+b))-log(c/(c+d))
#> 26 yi=a/(a+b)-c/(c+d)
#> 27 yi=events/n_total
#> 28 yi=log(events)-log(n_total-events)
#> 29 yi=log(events/n_total)
#> 30 yi=log(events1/person_time1)-log(events2/person_time2)
#> 31 yi=log(m1)-log(m2)
#> 32 yi=log(m1)-log(m2)
#> 33 yi=log(m1)-log(m2)
#> 34 yi=reported log hazard ratio; vi=reported SE(log HR)^2
#> variance_methods
#> 1 LS; J2_LS; JOINT_DELTA
#> 2 LS; J2_LS
#> 3 LS; J2_LS
#> 4 LS; J2_LS
#> 5 LS; J2_LS; JOINT_DELTA
#> 6 LS; J2_LS; JOINT_DELTA
#> 7 LS; J2_LS
#> 8 LS
#> 9 LS
#> 10 LS
#> 11 HET; LS; J2_LS; JOINT_DELTA
#> 12 HET; LS; J2_LS; JOINT_DELTA
#> 13 HET; LS; J2_LS; JOINT_DELTA
#> 14 LS
#> 15 LS
#> 16 LS
#> 17 LS
#> 18 LS
#> 19 LS
#> 20 LS
#> 21 LS
#> 22 LS
#> 23 LS
#> 24 LS
#> 25 LS
#> 26 LS
#> 27 LS
#> 28 LS
#> 29 LS
#> 30 LS
#> 31 LS
#> 32 LS
#> 33 LS
#> 34 LS
#> assumptions
#> 1 Independent groups; common population variance; normally distributed outcomes for correction/variance theory
#> 2 Unadjusted equal-variance Student t test; df=n1+n2-2; group1 minus group2
#> 3 Unadjusted two-group one-way ANOVA; numerator df=1; residual df=n1+n2-2; direction supplied
#> 4 Exact two-sided p from the unadjusted pooled Student t test; df=n1+n2-2; direction supplied
#> 5 SEs of unadjusted arithmetic arm means; independent observations; common population variance
#> 6 Two-sided Student-t CIs for unadjusted arm means; df_i=n_i-1; reported means agree with CI midpoints; common population variance
#> 7 Sample SD of exactly the two combined independent groups; common population variance; positive recovered within-group SS
#> 8 Independent unadjusted arm means; unequal population variances allowed; eligible SE/Student-t CI reconstruction when selected
#> 9 Independent unadjusted arm means; unequal population variances allowed; eligible SE/Student-t CI reconstruction when selected
#> 10 Independent unadjusted arm means; unequal population variances allowed; eligible SE/Student-t CI reconstruction when selected
#> 11 Independent normal outcomes; explicitly selected reference arm; HET allows unequal variances; LS/J2_LS assume equal population variances
#> 12 Independent normal outcomes; explicitly selected reference arm; HET allows unequal variances; LS/J2_LS assume equal population variances
#> 13 Independent normal outcomes; explicitly selected reference arm; HET allows unequal variances; LS/J2_LS assume equal population variances
#> 14 Independent bivariate-normal observations; Pearson correlation; no correction for attenuation
#> 15 Independent bivariate-normal observations; Pearson correlation; no correction for attenuation
#> 16 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable
#> 17 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable
#> 18 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable
#> 19 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable
#> 20 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable ; random-X multivariate-normal LS variance; Fisher transform is not variance stabilizing
#> 21 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable ; random-X multivariate-normal LS variance; Fisher transform is not variance stabilizing
#> 22 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable ; random-X multivariate-normal LS variance; Fisher transform is not variance stabilizing
#> 23 Ordinary OLS with intercept and independent normal observations; predictors counts focal predictor plus controls, excluding intercept; adjustment sets must be comparable ; random-X multivariate-normal LS variance; Fisher transform is not variance stabilizing
#> 24 Independent binomial arms; unadjusted contrast; zero-cell policy explicit; OR/RR yi are on log scale
#> 25 Independent binomial arms; unadjusted contrast; zero-cell policy explicit; OR/RR yi are on log scale
#> 26 Independent binomial arms; unadjusted contrast; zero-cell policy explicit; OR/RR yi are on log scale
#> 27 Independent Bernoulli observations; Wald/delta-method variance; boundary policy explicit
#> 28 Independent Bernoulli observations; Wald/delta-method variance; boundary policy explicit
#> 29 Independent Bernoulli observations; Wald/delta-method variance; boundary policy explicit
#> 30 Independent Poisson counts; positive comparable person-time exposures; no overdispersion adjustment
#> 31 Positive arithmetic means on a meaningful ratio scale; independent arms; LS delta-method variance; no small-sample bias correction
#> 32 Positive arithmetic means on a meaningful ratio scale; independent arms; LS delta-method variance; no small-sample bias correction
#> 33 Positive arithmetic means on a meaningful ratio scale; independent arms; LS delta-method variance; no small-sample bias correction
#> 34 Reported log hazard ratio and matching model-based or robust SE; proportional-hazards interpretation; adjustment status explicitly retained; no reconstruction from crude risks
#> reference
#> 1 Hedges (1981); metafor escalc SMD documentation; Lipsey and Wilson (2001), Appendix B (route family)
#> 2 Hedges (1981); metafor escalc SMD documentation; Lipsey and Wilson (2001), Appendix B (route family)
#> 3 Hedges (1981); metafor escalc SMD documentation; Lipsey and Wilson (2001), Appendix B (route family)
#> 4 Hedges (1981); metafor escalc SMD documentation; Lipsey and Wilson (2001), Appendix B (route family)
#> 5 Wilson (2023), companion calculator
#> 6 Cochrane Handbook chapter 6; inversion of declared Student-t mean interval
#> 7 Wilson (2023); within/between sums-of-squares identity
#> 8 Cochrane Handbook, chapter 6, reconstruction of arm summaries; metafor escalc, MD
#> 9 Cochrane Handbook, chapter 6, reconstruction of arm summaries; metafor escalc, MD
#> 10 Cochrane Handbook, chapter 6, reconstruction of arm summaries; metafor escalc, MD
#> 11 Hedges (1981), Distribution theory for Glass's estimator of effect size and related estimators
#> 12 Hedges (1981), Distribution theory for Glass's estimator of effect size and related estimators
#> 13 Hedges (1981), Distribution theory for Glass's estimator of effect size and related estimators
#> 14 metafor escalc, Pearson correlation coefficients: COR and ZCOR
#> 15 metafor escalc, Pearson correlation coefficients: COR and ZCOR
#> 16 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 17 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 18 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 19 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 20 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 21 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 22 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 23 Aloe and Becker (2012); Aloe and Thompson (2013); Aloe (2014); metafor escalc partial and semipartial correlations
#> 24 metafor escalc, measures for dichotomous variables: odds ratios, risk ratios and risk differences
#> 25 metafor escalc, measures for dichotomous variables: odds ratios, risk ratios and risk differences
#> 26 metafor escalc, measures for dichotomous variables: odds ratios, risk ratios and risk differences
#> 27 metafor escalc, proportions and transformed proportions: PR, PLO and PLN
#> 28 metafor escalc, proportions and transformed proportions: PR, PLO and PLN
#> 29 metafor escalc, proportions and transformed proportions: PR, PLO and PLN
#> 30 metafor escalc, measures for event counts per time unit: IRR
#> 31 Hedges et al. (1999); Lajeunesse (2011); metafor escalc, ratio of means (uncorrected LS)
#> 32 Hedges et al. (1999); Lajeunesse (2011); metafor escalc, ratio of means (uncorrected LS)
#> 33 Hedges et al. (1999); Lajeunesse (2011); metafor escalc, ratio of means (uncorrected LS)
#> 34 Reported log hazard ratio and its matching standard error; no effect reconstruction
#> source_url
#> 1 https://wviechtb.github.io/metafor/reference/escalc.html
#> 2 https://wviechtb.github.io/metafor/reference/escalc.html
#> 3 https://wviechtb.github.io/metafor/reference/escalc.html
#> 4 https://wviechtb.github.io/metafor/reference/escalc.html
#> 5 https://www.campbellcollaboration.org/calculator/d-means-ses
#> 6 https://www.cochrane.org/authors/handbooks-and-manuals/handbook/current/chapter-06
#> 7 https://www.campbellcollaboration.org/calculator/d-means-full-sample-sd
#> 8 https://wviechtb.github.io/metafor/reference/escalc.html
#> 9 https://wviechtb.github.io/metafor/reference/escalc.html
#> 10 https://wviechtb.github.io/metafor/reference/escalc.html
#> 11 https://wviechtb.github.io/metafor/reference/escalc.html
#> 12 https://wviechtb.github.io/metafor/reference/escalc.html
#> 13 https://wviechtb.github.io/metafor/reference/escalc.html
#> 14 https://wviechtb.github.io/metafor/reference/escalc.html
#> 15 https://wviechtb.github.io/metafor/reference/escalc.html
#> 16 https://wviechtb.github.io/metafor/reference/escalc.html
#> 17 https://wviechtb.github.io/metafor/reference/escalc.html
#> 18 https://wviechtb.github.io/metafor/reference/escalc.html
#> 19 https://wviechtb.github.io/metafor/reference/escalc.html
#> 20 https://wviechtb.github.io/metafor/reference/escalc.html
#> 21 https://wviechtb.github.io/metafor/reference/escalc.html
#> 22 https://wviechtb.github.io/metafor/reference/escalc.html
#> 23 https://wviechtb.github.io/metafor/reference/escalc.html
#> 24 https://wviechtb.github.io/metafor/reference/escalc.html
#> 25 https://wviechtb.github.io/metafor/reference/escalc.html
#> 26 https://wviechtb.github.io/metafor/reference/escalc.html
#> 27 https://wviechtb.github.io/metafor/reference/escalc.html
#> 28 https://wviechtb.github.io/metafor/reference/escalc.html
#> 29 https://wviechtb.github.io/metafor/reference/escalc.html
#> 30 https://wviechtb.github.io/metafor/reference/escalc.html
#> 31 https://wviechtb.github.io/metafor/reference/escalc.html
#> 32 https://wviechtb.github.io/metafor/reference/escalc.html
#> 33 https://wviechtb.github.io/metafor/reference/escalc.html
#> 34 <NA>
#> source_locator
#> 1 Measures for Two-Group Comparisons / SMD
#> 2 Measures for Two-Group Comparisons / SMD
#> 3 Measures for Two-Group Comparisons / SMD
#> 4 Measures for Two-Group Comparisons / SMD
#> 5 Mean SE reconstruction
#> 6 Section 6.5.2.2
#> 7 Combined-sample SD reconstruction
#> 8 Measures for quantitative variables: MD; selected arm-summary reconstruction is documented in compute_es
#> 9 Measures for quantitative variables: MD; selected arm-summary reconstruction is documented in compute_es
#> 10 Measures for quantitative variables: MD; selected arm-summary reconstruction is documented in compute_es
#> 11 Measures for quantitative variables: SMD1 (LS/LS2) and SMD1H; reference arm explicitly selected
#> 12 Measures for quantitative variables: SMD1 (LS/LS2) and SMD1H; reference arm explicitly selected
#> 13 Measures for quantitative variables: SMD1 (LS/LS2) and SMD1H; reference arm explicitly selected
#> 14 escalc definition of COR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 15 escalc definition of ZCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 16 escalc definition of PCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 17 escalc definition of PCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 18 escalc definition of ZPCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 19 escalc definition of ZPCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 20 escalc definition of SPCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 21 escalc definition of SPCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 22 escalc definition of ZSPCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 23 escalc definition of ZSPCOR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 24 escalc definition of OR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 25 escalc definition of RR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 26 escalc definition of RD; native route formulas and eligibility in compute-es/FAMILIES.md
#> 27 escalc definition of PR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 28 escalc definition of PLO; native route formulas and eligibility in compute-es/FAMILIES.md
#> 29 escalc definition of PLN; native route formulas and eligibility in compute-es/FAMILIES.md
#> 30 escalc definition of IRR; native route formulas and eligibility in compute-es/FAMILIES.md
#> 31 escalc definition of ROM; native route formulas and eligibility in compute-es/FAMILIES.md
#> 32 escalc definition of ROM; native route formulas and eligibility in compute-es/FAMILIES.md
#> 33 escalc definition of ROM; native route formulas and eligibility in compute-es/FAMILIES.md
#> 34 compute-es/FAMILIES.md: reported log HR and matching SE; the originating survival model supplies the estimate
#> method_version optional default_correction
#> 1 1.6.0 hedges_exact
#> 2 1.0.0 hedges_exact
#> 3 1.0.0 hedges_exact
#> 4 1.0.0 hedges_exact
#> 5 1.6.0 hedges_exact
#> 6 1.6.0 ci_tolerance (default 1e-8) hedges_exact
#> 7 1.0.0 hedges_exact
#> 8 1.2.0 none
#> 9 1.2.0 none
#> 10 1.2.0 ci_tolerance (default 1e-8) none
#> 11 1.6.0 hedges_exact
#> 12 1.6.0 hedges_exact
#> 13 1.6.0 ci_tolerance (default 1e-8) hedges_exact
#> 14 1.3.0 none
#> 15 1.3.0 none
#> 16 1.3.0 none
#> 17 1.3.0 none
#> 18 1.3.0 none
#> 19 1.3.0 none
#> 20 1.3.0 none
#> 21 1.3.0 none
#> 22 1.3.0 none
#> 23 1.3.0 none
#> 24 1.3.0 none
#> 25 1.3.0 none
#> 26 1.3.0 none
#> 27 1.3.0 none
#> 28 1.3.0 none
#> 29 1.3.0 none
#> 30 1.3.0 none
#> 31 1.3.0 none
#> 32 1.3.0 none
#> 33 1.3.0 ci_tolerance (default 1e-8) none
#> 34 1.3.0 none
#> default_variance_method analysis_scale
#> 1 LS standardized_mean_difference
#> 2 LS standardized_mean_difference
#> 3 LS standardized_mean_difference
#> 4 LS standardized_mean_difference
#> 5 LS standardized_mean_difference
#> 6 LS standardized_mean_difference
#> 7 LS standardized_mean_difference
#> 8 LS raw_mean_difference
#> 9 LS raw_mean_difference
#> 10 LS raw_mean_difference
#> 11 HET standardized_mean_difference
#> 12 HET standardized_mean_difference
#> 13 HET standardized_mean_difference
#> 14 LS correlation
#> 15 LS fisher_z
#> 16 LS partial_correlation
#> 17 LS partial_correlation
#> 18 LS fisher_z_partial
#> 19 LS fisher_z_partial
#> 20 LS semipartial_correlation
#> 21 LS semipartial_correlation
#> 22 LS fisher_z_semipartial
#> 23 LS fisher_z_semipartial
#> 24 LS log_odds_ratio
#> 25 LS log_risk_ratio
#> 26 LS risk_difference
#> 27 LS proportion
#> 28 LS logit_proportion
#> 29 LS log_proportion
#> 30 LS log_rate_ratio
#> 31 LS log_response_ratio
#> 32 LS log_response_ratio
#> 33 LS log_response_ratio
#> 34 LS log_hazard_ratio
#> variance_formula
#> 1 LS: 1/n1+1/n2+yi^2/(2*(n1+n2)); J2_LS: J^2*(1/n1+1/n2+d^2/(2*(n1+n2))); JOINT_DELTA: J^2*(sd1^2/n1+sd2^2/n2)/q+yi^2*sum(w_i^2*sd_i^4/(n_i-1))/(2*q^2); w_i=(n_i-1)/(n1+n2-2); q=sum(w_i*sd_i^2)
#> 2 LS: 1/n1+1/n2+yi^2/(2*(n1+n2)); J2_LS: J^2*(1/n1+1/n2+d^2/(2*(n1+n2)))
#> 3 LS: 1/n1+1/n2+yi^2/(2*(n1+n2)); J2_LS: J^2*(1/n1+1/n2+d^2/(2*(n1+n2)))
#> 4 LS: 1/n1+1/n2+yi^2/(2*(n1+n2)); J2_LS: J^2*(1/n1+1/n2+d^2/(2*(n1+n2)))
#> 5 LS: 1/n1+1/n2+yi^2/(2*(n1+n2)); J2_LS: J^2*(1/n1+1/n2+d^2/(2*(n1+n2))); JOINT_DELTA: J^2*(sd1^2/n1+sd2^2/n2)/q+yi^2*sum(w_i^2*sd_i^4/(n_i-1))/(2*q^2); w_i=(n_i-1)/(n1+n2-2); q=sum(w_i*sd_i^2)
#> 6 LS: 1/n1+1/n2+yi^2/(2*(n1+n2)); J2_LS: J^2*(1/n1+1/n2+d^2/(2*(n1+n2))); JOINT_DELTA: J^2*(sd1^2/n1+sd2^2/n2)/q+yi^2*sum(w_i^2*sd_i^4/(n_i-1))/(2*q^2); w_i=(n_i-1)/(n1+n2-2); q=sum(w_i*sd_i^2)
#> 7 LS: 1/n1+1/n2+yi^2/(2*(n1+n2)); J2_LS: J^2*(1/n1+1/n2+d^2/(2*(n1+n2)))
#> 8 LS: sd1^2/n1+sd2^2/n2
#> 9 LS: sd1^2/n1+sd2^2/n2
#> 10 LS: sd1^2/n1+sd2^2/n2
#> 11 HET: (sd_other/sd_reference)^2/(n_other-1)+1/(n_reference-1)+yi^2/(2*(n_reference-1)); LS: 1/n1+1/n2+yi^2/(2*n_reference); J2_LS: J^2*(1/n1+1/n2+d^2/(2*n_reference)); JOINT_DELTA: J^2*(sd1^2/n1+sd2^2/n2)/sd_reference^2+yi^2/(2*(n_reference-1))
#> 12 HET: (sd_other/sd_reference)^2/(n_other-1)+1/(n_reference-1)+yi^2/(2*(n_reference-1)); LS: 1/n1+1/n2+yi^2/(2*n_reference); J2_LS: J^2*(1/n1+1/n2+d^2/(2*n_reference)); JOINT_DELTA: J^2*(sd1^2/n1+sd2^2/n2)/sd_reference^2+yi^2/(2*(n_reference-1))
#> 13 HET: (sd_other/sd_reference)^2/(n_other-1)+1/(n_reference-1)+yi^2/(2*(n_reference-1)); LS: 1/n1+1/n2+yi^2/(2*n_reference); J2_LS: J^2*(1/n1+1/n2+d^2/(2*n_reference)); JOINT_DELTA: J^2*(sd1^2/n1+sd2^2/n2)/sd_reference^2+yi^2/(2*(n_reference-1))
#> 14 LS: (1-r^2)^2/(n_total-1)
#> 15 LS: 1/(n_total-3)
#> 16 LS: (1-r^2)^2/(n_total-predictors)
#> 17 LS: (1-r^2)^2/(n_total-predictors)
#> 18 LS: 1/(n_total-predictors-2)
#> 19 LS: 1/(n_total-predictors-2)
#> 20 LS: ((1-R2)^2+(R2-r^2)*(1-R2+r^2))/n_total
#> 21 LS: ((1-R2)^2+(R2-r^2)*(1-R2+r^2))/n_total
#> 22 LS: v_SPCOR/(1-r^2)^2
#> 23 LS: v_SPCOR/(1-r^2)^2
#> 24 LS: 1/a+1/b+1/c+1/d
#> 25 LS: 1/a-1/(a+b)+1/c-1/(c+d)
#> 26 LS: p1*(1-p1)/n1+p2*(1-p2)/n2
#> 27 LS: p*(1-p)/n_total
#> 28 LS: 1/events+1/non_events
#> 29 LS: 1/events-1/n_total
#> 30 LS: 1/events1+1/events2
#> 31 LS: sd1^2/(n1*m1^2)+sd2^2/(n2*m2^2)
#> 32 LS: sd1^2/(n1*m1^2)+sd2^2/(n2*m2^2)
#> 33 LS: sd1^2/(n1*m1^2)+sd2^2/(n2*m2^2)
#> 34 LS: estimate_se^2
#> effect_direction
#> 1 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 2 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 3 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 4 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 5 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 6 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 7 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 8 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 9 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 10 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 11 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 12 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 13 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 14 Sign of the supplied correlation or signed regression t
#> 15 Sign of the supplied correlation or signed regression t
#> 16 Sign of the supplied correlation or signed regression t
#> 17 Sign of the supplied correlation or signed regression t
#> 18 Sign of the supplied correlation or signed regression t
#> 19 Sign of the supplied correlation or signed regression t
#> 20 Sign of the supplied correlation or signed regression t
#> 21 Sign of the supplied correlation or signed regression t
#> 22 Sign of the supplied correlation or signed regression t
#> 23 Sign of the supplied correlation or signed regression t
#> 24 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 25 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 26 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 27 Frequency of the designated event
#> 28 Frequency of the designated event
#> 29 Frequency of the designated event
#> 30 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 31 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 32 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 33 Group 1 minus group 2, or log(group 1/group 2) for ratios
#> 34 Direction of the supplied reported log hazard ratio