| dgm | R Documentation |
S3 Method for defining data-generating mechanisms. See simulate_dgm() for
usage and further details.
dgm(dgm_name, settings)
dgm_name |
Character string specifying the DGM type |
settings |
List containing the required parameters for the DGM or numeric condition_id |
A data frame with simulated data following the structure described
in the Output Structure section. This is an S3 generic method that dispatches
to specific DGM implementations based on dgm_name.
The returned data frame follows a standardized schema that downstream functions rely on. Across the currently implemented DGMs, the following columns are used:
yi (numeric): The effect size estimate.
sei (numeric): Standard error of yi.
ni (integer): Total sample size for the estimate
(e.g., sum over groups where applicable).
es_type (character): Effect size type, used to disambiguate
the scale of yi. Currently used values are
"SMD" (standardized mean difference / Cohen's d),
"logOR" (log odds ratio), and "none"
(unspecified generic continuous coefficient).
study_id (integer/character, optional): Identifier of the
primary study/cluster when a DGM yields multiple estimates per study
(e.g., Alinaghi2018, PRE). If absent, each row is treated as an
independent study.
simulate_dgm()
simulate_dgm("Carter2019", 1)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.