PublicationBiasBenchmark (version 0.1.3)

retrieve_dgm_measures: Retrieve Pre-Computed Performance measures for a DGM

Description

This function returns pre-computed performance measures for a specified Data-Generating Mechanism (DGM). The pre-computed measures must be already stored locally. See download_dgm_measures() function for more guidance.

Usage

retrieve_dgm_measures(
  dgm_name,
  measure = NULL,
  method = NULL,
  method_setting = NULL,
  condition_id = NULL,
  replacement = FALSE
)

Value

A data.frame

Arguments

dgm_name

Character string specifying the DGM type

measure

Which performance measure should be returned (e.g., "bias", "mse", "coverage"). All measures can be returned by setting to NULL.

method

Which method(s) should be returned. The complete results are returned by setting to NULL (default setting).

method_setting

Which method setting(s) should be returned. The complete results are returned by setting to NULL (default setting).

condition_id

which conditions should settings be returned for.

replacement

Whether performance measures computed using replacement should be returned. Defaults to FALSE.

Examples

# \donttest{
  # get bias measures for all methods and conditions
  retrieve_dgm_measures("no_bias", measure = "bias")

  # get all measures for RMA method
  retrieve_dgm_measures("no_bias", method = "RMA")

  # get MSE measures for PET method in condition 1
  retrieve_dgm_measures("no_bias", measure = "mse", method = "PET", condition_id = 1)
# }