Retrieve a Pre-Simulated Condition and Repetition From a DGM — retrieve_dgm

This function returns a pre-simulated dataset of a given repetition and condition from a dgm. The pre-simulated datasets must be already stored locally. See download_dgm_datasets() function for more guidance.

Usage

retrieve_dgm_dataset(dgm_name, condition_id, repetition_id = NULL, path = NULL)

Arguments

dgm_name: Character string specifying the DGM type
condition_id: which conditions should settings be returned for.
repetition_id: Which repetition should be returned. The complete condition can be returned by setting to either NULL.
path: Character string specifying the directory path where the datasets/results/measures should be saved. Defaults to the location specified via PublicationBiasBenchmark.get_option("simulation_directory"). The objects are stored in dgm_name/datasets, dgm_name/results, dgm_name/measures subfolders.

Value

A data.frame

Examples

if (FALSE) { # \dontrun{
  # get condition 1, repetition 1
  retrieve_dgm_dataset("no_bias", condition_id = 1, repetition_id = 1)

  # get condition 1, all repetitions
  retrieve_dgm_dataset("no_bias", condition_id = 1)
} # }