filter_ma: Filter meta-analyses

View source: R/filter_ma.R

filter_maR Documentation

Filter meta-analyses

Description

Filter psychmeta meta-analysis objects based on specified criteria.

Usage

filter_ma(
  ma_obj,
  analyses = "all",
  match = c("all", "any"),
  case_sensitive = TRUE,
  ...
)

filter_meta(
  ma_obj,
  analyses = "all",
  match = c("all", "any"),
  case_sensitive = TRUE,
  ...
)

Arguments

ma_obj

A psychmeta meta-analysis object.

analyses

Which analyses to extract? Can be either "all" to extract all meta-analyses in the object (default) or a list containing one or more of the following arguments:

  • construct: A list or vector of construct names to search for.

  • construct_pair: A list of vectors of construct pairs to search for.
    (e.g., list(c("X", "Y"), c("X", "Z")) ).

  • pair_id: A list or vector of numeric construct pair IDs (unique construct-pair indices).

  • analysis_id: A list or vector of numeric analysis IDs (unique analysis indexes).

  • k_min: A numeric value specifying the minimum k for extracted meta-analyses.

  • N_min: A numeric value specifying the minimum N for extracted meta-analyses.

match

Should extracted meta-analyses match all (default) or any of the criteria given in analyses?

case_sensitive

Logical scalar that determines whether character values supplied in analyses should be treated as case sensitive (TRUE, default) or not (FALSE).

...

Additional arguments.

Value

A psychmeta meta-analysis object with analyses matching the specified criteria.

Examples

ma_obj <- ma_r(ma_method = "ic", rxyi = rxyi, n = n, rxx = rxxi, ryy = ryyi,
               construct_x = x_name, construct_y = y_name, sample_id = sample_id, citekey = NULL,
               moderators = moderator, data = data_r_meas_multi,
               impute_artifacts = FALSE, clean_artifacts = FALSE)
ma_obj <- ma_r_ad(ma_obj, correct_rr_x = FALSE, correct_rr_y = FALSE)

filter_ma(ma_obj, analyses="all")
filter_ma(ma_obj, analyses=list(construct="X"), match="all")
filter_ma(ma_obj, analyses=list(construct="X", k_min=21), match="any")
filter_ma(ma_obj, analyses=list(construct="X", k_min=21), match="all")

psychmeta/psychmeta documentation built on Feb. 12, 2024, 1:21 a.m.