recordEffect

the effect of ONE gene on ONE model parameter

Information

Pairs a Gene with what one of its phenotypes does to a single model parameter. Several effects share one gene record, so adding a gene and adding an effect are independent.

The scale is multiplicative. Papers do not always report it that way — Jung et al. (2024) give the CYP2C19 effect on clopidogrel's fm1/fm2 as an additive shift on logit(fm) — but for a fixed set of phenotypes the reported per-phenotype values convert to exact ratios, which is what the shipped effects store.

Parameters

TypeNameDefaultDescription
Genegene
Stringtarget""the parameter scaled, e.g. "CL", "fm1", "EC50"
Realscale{1.0, 1.0, 1.0, 1.0, 1.0, 1.0}