associate$mr
Mendelian-randomization entry point for PolyGeniusData
Description
associate$mr() declares the Mendelian-randomization surface for PolyGenius. The function validates the requested inputs, but no MR estimator backend is currently implemented.
The function is kept in the public association environment so that the MR API shape and documentation remain stable while the estimator layer is developed.
Usage
`associate$mr`(data, exposure, outcome, instruments = c("prs", "variants"), method = c("ivw", "egger", "median"), covariates = NULL, weights = NULL, output = c("summary", "models"), ...)
Arguments
data
|
A |
exposure
|
Unquoted exposure expression. |
outcome
|
Unquoted outcome expression. |
instruments
|
Instrument type. |
method
|
MR estimator label. |
covariates
|
Optional unquoted covariate expression. |
weights
|
Optional unquoted weights expression or numeric vector. |
output
|
One of |
…
|
Reserved for future MR backends. |
Value
This function currently errors with a clear not-yet-implemented message after validating the requested interface.
See Also
associate