Learn R Programming

⚠️There's a newer version (2.7.0) of this package.Take me there.

psychmeta

Psychometric Meta-Analysis Toolkit

Overview

The psychmeta package provides tools for computing bare-bones and psychometric meta-analyses and for generating psychometric data for use in meta-analysis simulations. Currently, the package supports bare-bones, individual-correction, and artifact-distribution methods for meta-analyzing correlations and d values. Please refer to the overview vignette vignette("overview", package = "psychmeta") for an introduction to psychmeta's functions and workflows (also found here).

Authors

psychmeta was written by Jeffrey A. Dahlke and Brenton M. Wiernik.

Installation

The official CRAN release of psychmeta can be installed with the following code:

install.packages("psychmeta")

Development versions of psychmeta from GitHub reflect updates made to the package between official CRAN releases. The GitHub release can be installed with the following code:

install.packages("remotes")
remotes::install_github("psychmeta/psychmeta")

Citing psychmeta

To cite psychmeta in your research, please refer to the package's citation information using the citation() function.

citation("psychmeta")

Reporting Issues

To report a bug or other issue, tell us about it on GitHub or email issues@psychmeta.com. For more general questions and inquiries about the package, reach out to us via Twitter or email psychmeta@psychmeta.com.

Copy Link

Version

Install

install.packages('psychmeta')

Monthly Downloads

600

Version

2.6.5

License

GPL (>= 3)

Maintainer

Jeffrey A. Dahlke

Last Published

August 26th, 2022

Functions in psychmeta (2.6.5)

clean_warning

Clean warnings and remove warnings present in the environment before running the function of interest
composite_d_scalar

Scalar formula to estimate the standardized mean difference associated with a composite variable
adjust_n_d

Adjusted sample size for a non-Cohen d value for use in a meta-analysis of Cohen's d values
anova.ma_psychmeta

Wald-type tests for moderators in psychmeta meta-analyses
composite_d_matrix

Matrix formula to estimate the standardized mean difference associated with a weighted or unweighted composite variable
check_wt_type

Check whether wt_type argument is valid and determine which package to use for weights
adjust_n_r

Adjusted sample size for a non-Pearson correlation coefficient for use in a meta-analysis of Pearson correlations
composite_r_scalar

Scalar formula to estimate the correlation between a composite and another variable or between two composite variables
composite_r_matrix

Matrix formula to estimate the correlation between two weighted or unweighted composite variables
composite_rel_matrix

Matrix formula to estimate the reliability of a weighted or unweighted composite variable
confidence_r

Construct a confidence interval for correlations using Fisher's z transformation
compute_dmod

Comprehensive \(d_{Mod}\) calculator
composite_u_matrix

Matrix formula to estimate the u ratio of a composite variable
compute_dmod_npar

Function for computing non-parametric \(d_{Mod}\) effect sizes for a single focal group
composite_u_scalar

Scalar formula to estimate the u ratio of a composite variable
conf.limits.nc.chisq

Confidence limits for noncentral chi square parameters (function and documentation from package 'MBESS' version 4.4.3) Function to determine the noncentral parameter that leads to the observed Chi.Square-value, so that a confidence interval for the population noncentral chi-squrae value can be formed.
composite_rel_scalar

Scalar formula to estimate the reliability of a composite variable
confidence

Construct a confidence interval
compute_alpha

Compute coefficient alpha
compute_dmod_par

Function for computing parametric \(d_{Mod}\) effect sizes for any number of focal groups
convert_pq_to_p

Convert the dichotomous variable variance to a proportion
control_psychmeta

Control for psychmeta meta-analyses
confint

Confidence interval method for objects of classes deriving from "lm_mat"
control_intercor

Control function to curate intercorrelations to be used in automatic compositing routine
convert_reltype2consistency

Convert string variable containing reliability type indicators to a logical variable indicating whether a reliability value is an internal-consistency estimate or a multiple-administration estimate
convert_consistency2reltype

Convert logical variable indicating whether a reliability value is an internal-consistency estimate or a multiple-administration estimate to a string variable of generic reliability types
convert_sdd_to_sdr

Convert the SD of d to the SD of r via TSA
convert_sdr_to_sdd

Convert the SD of r to the SD of d via TSA
convert_ma

Function to convert meta-analysis of correlations to d values or vice-versa
convert_es

Convert effect sizes
correct_r_coarseness

Correct correlations for scale coarseness
correct_r

Correct correlations for range restriction and/or measurement error
correct_means_mvrr

Multivariate select/correction for vectors of means
correct_r_bias

Correct correlations for small-sample bias
correct_d

Correct \(d\) values for measurement error and/or range restriction
correct_d_bias

Correct for small-sample bias in Cohen's \(d\) values
convert_varr_to_vard

Convert the variance of r to the variance of d via TSA
correct_matrix_mvrr

Multivariate select/correction for covariance matrices
create_ad

Generate an artifact distribution object for use in artifact-distribution meta-analysis programs.
correct_glass_bias

Correct for small-sample bias in Glass' \(\Delta\) values
convert_vard_to_varr

Convert the variance of d to the variance of r via TSA
correct_r_dich

Correct correlations for artificial dichotomization of one or both variables
credibility

Construct a credibility interval
correct_r_split

Correct correlations for uneven/unrepresentative splits
data_r_gonzalezmule_2014

Meta-analysis of OCB correlations with other constructs
data_d_meas_multi

Hypothetical d value dataset simulated to satisfy the assumptions of the correction for measurement error only in multiple constructs
create_ad_array

Create an array of all possible combinations of artifact values from 2-4 artifact distributions
data_d_bb_multi

Hypothetical d value dataset simulated with sampling error only
create_ad_tibble

Create a tibble of artifact distributions by construct
create_ad_group

Generate an artifact distribution object for a dichotomous grouping variable.
data_r_oh_2009

Second order meta-analysis of operational validities of big five personality measures across East Asian countries
data_r_roth_2015

Artifact-distribution meta-analysis of the correlation between school grades and cognitive ability
data_r_mcdaniel_1994

Artifact-distribution meta-analysis of the validity of interviews
data_r_bvirr

Hypothetical dataset simulated to satisfy the assumptions of the bivariate correction for indirect range restriction
data_r_uvdrr

Hypothetical dataset simulated to satisfy the assumptions of the univariate correction for direct range restriction
data_r_mcleod_2007

Bare-bones meta-analysis of parenting and childhood depression
data_r_uvirr

Hypothetical dataset simulated to satisfy the assumptions of the univariate correction for indirect range restriction
.attenuate_r_rb

Internal function to attenuate correlations using Raju and Burke's formula for univariate direct range restriction
.attenuate_r_uvdrr

Internal function to undo the Case II correction for univariate direct range restriction
.convert_metatab

Function to convert a meta-analysis of correlations to a meta-analysis of d values or vice-versa (does one table)
.attenuate_r_uvirr

Internal function to undo the Case IV correction for univariate indirect range restriction
.correct_r_uvirr

Internal function to compute the Case IV correction for univariate indirect range restriction
.identify_ma_cols

Identify meta-analysis type and provide new column names for a meta-analysis
.heterogeneity

Computation of heterogeneity indices from meta-analytic results
.attenuate_r_bvdrr

Internal function to undo the Case V correction for bivariate indirect range restriction
data_r_meas

Hypothetical dataset simulated to satisfy the assumptions of the correction for measurement error only
.create_ad_int

Create a tabular array of artifact information summarizing values and weights of values in an interactive artifact distribution
.correct_r_uvdrr

Internal function to compute the Case II correction for univariate direct range restriction
.ma_r_ic

Internal function for computing individual-correction meta-analyses of correlations
data_r_bvdrr

Hypothetical dataset simulated to satisfy the assumptions of the bivariate correction for direct range restriction
data_r_meas_multi

Hypothetical correlation dataset simulated to satisfy the assumptions of the correction for measurement error only in multiple constructs
.ma_r_ic_boot

Internal function for computing bootstrapped individual-correction meta-analyses of all varieties
.ma_r_order2_bb_boot

Internal function for computing bootstrapped second-order bare-bones meta-analyses of correlations
.correct_r_bvdrr

Internal function to compute the correction for bivariate direct range restriction
.correct_r_rb

Internal function to compute Raju and Burke's correction for univariate direct range restriction
.attenuate_r_bvirr

Internal function to undo the Case V correction for bivariate indirect range restriction
.ma_artifacts

Internal function for computing meta-analyses of artifacts
.correct_r_bvirr

Internal function to compute the Case V correction for bivariate indirect range restriction
.plot_funnel

Internal funnel-plot generator
.ma_r_order2_ad_boot

Internal function for computing bootstrapped second-order artifact-distribution meta-analyses of correlations
.rbeta

Generate values from a beta distribution, given a mean and standard deviation of the distribution
.plot_forest_meta

Internal plotting function for forest plots
estimate_matrix_prods

Estimate covariance matrices and mean vectors containing product terms
.ma_r_bb_boot

Internal function for computing bootstrapped bare-bones meta-analyses of correlations
.ma_r_bb

Internal function for computing bare-bones meta-analyses of correlations
.ma_r_order2

Internal function for computing individual-correction meta-analyses of correlations
.tau_squared_r_solver

tau_r_squared Solver
.tau_squared_m_solver

tau_m_squared Solver
.ma_r_icvgy_boot

Internal function for computing bootstrapped individual-correction meta-analyses of validity generalization correlations for Y
.ma_bootstrap

Wrapper function to facilitate bootstrapped meta-analyses
.refine_var_rr

Range-restriction refinement factor (i.e., "a") for correlations' corrected sampling variances
estimate_prod

Estimation of statistics computed from products of random, normal variables
.estimate_attenuation

Estimate the compound attenuation factors (i.e., "A") for correlations
.ma_generic

Internal function for computing bare-bones meta-analyses of generic effect sizes
.descriptives_database

Compute weighted descriptive statistics for a database
.ma_r_icvgx_boot

Internal function for computing bootstrapped individual-correction meta-analyses of validity generalization correlations for X
.ma_r_icts_boot

Internal function for computing bootstrapped individual-correction meta-analyses of true-score correlations
.ma_d_bb_boot

Internal function for computing bootstrapped bare-bones meta-analyses of d values
.ma_generic_boot

Internal function for computing bootstrapped bare-bones meta-analyses of generic effect sizes
.lambda_bvirr

Internal function to produce lambda coefficients to use in the Case V correction for bivariate indirect range restriction.
.integrate_dmod

Integration function for computing parametric signed or unsigned \(d_{Mod}\) effect sizes for a single focal group
estimate_rel_dist

Estimate descriptive statistics of reliabilities
estimate_q_dist

Estimate descriptive statistics of square-root reliabilities
estimate_var_artifacts

Taylor series approximations for the variances of estimates artifact distributions.
.ma_cumulative

Cumulative meta-analyses
estimate_rel_sb

Spearman-Brown prophecy formula to estimate the reliability of a lengthened measure
.ma_d_bb

Internal function for computing bare-bones meta-analyses of d values
.ma_r_order2_ic_boot

Internal function for computing bootstrapped second-order individual-correction meta-analyses of correlations
.print.summary.lm_mat

Print method for objects of the class "summary.lm_mat"
.print.lm_mat

Print method for objects of the class "lm_mat"
.metabulate

Internal function for .metabulating results tables
estimate_artifacts

Estimation of applicant and incumbent reliabilities and of true- and observed-score u ratios
filter_ma

Filter meta-analyses
.ma_leave1out

Leave-one-out (i.e., jackknife) meta-analyses
filter_listnonnull

Filter a list to remove NULL entries
estimate_length_sb

Inverse Spearman-Brown formula to estimate the amount by which a measure would have to be lengthened or shorted to achieve a desired level of reliability
estimate_var_rho_int

Non-linear estimate of variance of \(\rho\) corrected for psychometric artifacts using numeric integration
filter_u

Filter to remove impossible values from vectors of u ratios and corresponding weights.
filter_rel

Filter to remove impossible values from vectors of reliabilities and corresponding weights.
format_wide

Create wide-format datasets in simulate_r_database
estimate_u

Estimate u ratios from available artifact information
generate_bib

Generate a list of references included in meta-analyses
get_stuff

Extract results from a psychmeta meta-analysis object
estimate_var_tsa

Taylor Series Approximation of effect-size variances corrected for psychometric artifacts
generate_directory

Generate a system of folders from a file path to a new directory
estimate_var_rho_tsa

Taylor Series Approximation of variance of \(\rho\) corrected for psychometric artifacts
format_long

Create long-format datasets in simulate_r_database
format_num

Format numbers for presentation
filter_r_bar

Filter to detect and remove impossible values in vectors of meta-analytic mean correlations and numbers of studies
filter_r

Filter to detect and remove impossible values in vectors of correlations and sample sizes.
lm_mat

Compute linear regression models and generate "lm" objects from covariance matrices.
ma_generic

Bare-bones meta-analysis of generic effect sizes
limits_tau2

Confidence limits of tau-squared
limits_tau

Confidence limits of tau
interval_warning

Warning message for the widths of uncertainty intervals
ma_d

Meta-analysis of d values
heterogeneity

Supplemental heterogeneity statistics for meta-analyses
ma_d_order2

Second-order meta-analysis function for d values
ma_r

Meta-analysis of correlations
impute_artifacts

Impute missing and impossible artifact values
ma_r_ad.tsa_bvirr

Taylor series approximation artifact-distribution meta-analysis correcting for Case V indirect range restriction and measurement error
ma_r_ad.int_rbAdj

Interactive artifact-distribution meta-analysis correcting for Case II direct range restriction and measurement error
ma_r_ad.int_uvdrr

Interactive artifact-distribution meta-analysis correcting for Case II direct range restriction and measurement error
ma_r_ad.tsa_uvirr

Taylor series approximation artifact-distribution meta-analysis correcting for Case II direct range restriction and measurement error
ma_r_ad.tsa_rb2Orig

Taylor series approximation artifact-distribution meta-analysis correcting for Raju and Burke's case 2 direct range restriction and measurement error
ma_r_ad.int_uvirr

Interactive artifact-distribution meta-analysis correcting for Case IV indirect range restriction and measurement error
ma_r_ad.tsa_uvdrr

Taylor series approximation artifact-distribution meta-analysis correcting for Case II direct range restriction and measurement error
ma_r_ad.tsa_rb1Orig

Taylor series approximation artifact-distribution meta-analysis correcting for Raju and Burke's case 1 direct range restriction and measurement error
ma_r_ad.int_meas

Interactive artifact-distribution meta-analysis correcting for measurement error
ma_r_ad.int_rbOrig

Interactive artifact-distribution meta-analysis correcting for Case II direct range restriction and measurement error
ma_r_ad.tsa_bvdrr

Taylor series approximation artifact-distribution meta-analysis correcting for Case V indirect range restriction and measurement error
ma_r_ad.int_bvirr

Interactive artifact-distribution meta-analysis correcting for Case V indirect range restriction and measurement error
ma_r_ad.tsa_rb2Adj

Taylor series approximation artifact-distribution meta-analysis correcting for Raju and Burke's case 2 direct range restriction and measurement error
ma_r_ad.int_bvdrr

Interactive artifact-distribution meta-analysis correcting for Case V indirect range restriction and measurement error
manage_arglength

Check the length of x against the length of y and replicate z if necessary
ma_r_ad.int_none

Null artifact distribution result: No corrections performed
ma_r_order2

Second-order meta-analysis function for correlations
merge_simdat_d

Merge multiple "simdat_d_database" class objects
merge_simdat_r

Merge multiple "simdat_r_database" class objects
ma_r_ad.tsa_meas

Taylor series approximation artifact-distribution meta-analysis correcting for measurement error
ma_wrapper

Wrapper function to compute meta-analytic results for all analyses.
metareg

Compute meta-regressions
ma_r_ad.tsa_rb1Adj

Taylor series approximation artifact-distribution meta-analysis correcting for Raju and Burke's case 1 direct range restriction and measurement error
mix_matrix

Estimate mixture covariance matrix from within-group covariance matrices
mix_r_2group

Estimate the mixture correlation for two groups
record_warnings

Summary of warning messages generated within a function
plot_forest

Create forest plots
record_fyis

Summary of FYI messages generated within a function
organize_moderators

Organization of moderator data for use in meta-analyses
psychmeta-package

psychmeta: Psychometric meta-analysis toolkit
reattribute

Copy class and attributes from the original version of an object to a modified version.
organize_database

Organize a database of multi-construct or moderated information
predict

Prediction method for objects of classes deriving from "lm_mat"
metabulate

Write a summary table of meta-analytic results
metabulate_rmd_helper

Add metabulate equation commands and LaTeX dependencies
plot_funnel

Create funnel plots
print

Print methods for psychmeta
mix_dist

Descriptive statistics for a mixture distribution
reshape_vec2mat

Assemble a variance-covariance matrix
reshape_mat2dat

Extract a long-format correlation database from a correlation matrix and its supporting vectors/matrices of variable information
reshape_wide2long

Reshape database from wide format to long format
round2char

Round numeric values to an exact number of digits and return as a character
sparsify_simdat_d

Create sparse artifact information in a "simdat_d_database" class object
sparsify_simdat_r

Create sparse artifact information in a "simdat_r_database" class object
sensitivity

Sensitivity analyses for meta-analyses
simulate_alpha

Generate a vector of simulated sample alpha coefficients
simulate_d_database

Simulate d value databases of primary studies
simulate_d_sample

Simulate a sample of psychometric d value data with measurement error, direct range restriction, and/or indirect range restriction
unmix_r_2group

Estimate the average within-group correlation from a mixture correlation for two groups
truncate_dist

Truncation function for normal distributions (truncates both mean and variance)
screen_ad_int

Screen to detect invalid interactive artifact distribution objects
scalar_arg_warning

Warning message for scalar arguments receiving multiple values
summarize_ads

Summarize artifact information from meta-analyses into table format
screen_ad_tsa

Screen to detect invalid Taylor series artifact distribution objects
screen_r

Screen to detect impossible values in vectors of correlations and sample sizes.
screen_rel

Screen to detect impossible values in vectors of reliability estimates.
simulate_matrix

Generate a list of simulated sample matrices sampled from the Wishart distribution
truncate_mean

Truncation function for means
wt_cov

Compute weighted covariances
wt_dist

Weighted descriptive statistics for a vector of numbers
var_error_alpha

Analytic estimate of the sampling variance of coefficient \(\alpha\)
var_error_d

Estimate the error variance Cohen's \(d\) values
screen_u

Screen to detect impossible values in vectors of u ratios.
var_error_A

Estimate the error variance of the probability-based effect size (\(A\), AUC, the common language effect size [CLES])
simulate_psych

Simulate Monte Carlo psychometric data (observed, true, and error scores)
summary

Summary methods for psychmeta
var_error_spearman

Estimate the error variance of Spearman rank correlations
var_error_rel

Estimate the error variance of reliability estimates
simulate_r_sample

Simulation of data with measurement error and range-restriction artifacts
var_error_mult_R

Estimate the error variance of linear regression multiple R(-squared)
simulate_r_database

Simulate correlation databases of primary studies
var_error_q

Estimate the error variance of square roots of reliability estimates
truncate_var

Truncation function for variances
unmix_matrix

Estimate average within-group covariance matrices from a mixture covariance matrix
var_error_g

Estimate the error variance Hedges's \(g\) values
var_error_delta

Estimate the error variance of Glass's \(\Delta\) values
var_error_u

Estimate the error variance of \(u\) ratios
warning_variance

Warning message for invalid variances
var_error_r

Estimate the error variance of correlations
var_error_r_bvirr

Taylor series approximation of the sampling variance of correlations corrected using the bivariate indirect range restriction correction (Case V)