| kendler_simplified | R Documentation |
Function to calculate the simplified version of Kendler's FGRS based on family data.
kendler_simplified(
.tbl = NULL,
family_graphs = NULL,
family_graphs_col = "fam_graph",
pid = "pid",
fid = "fid",
role = NULL,
dadcol,
momcol,
env_cor_sib = 0,
env_cor_f = 0,
env_cor_m = 0
)
.tbl |
A matrix, list or data frame that can be converted into a tibble. Must have at least five columns that hold the family identifier, the personal identifier, the role and the lower and upper thresholds. Note that the role must be one of the following abbreviations
Defaults to |
family_graphs |
A tibble with columns pid and family_graph_col, dadcol, and momcol. See prepare_graph for construction of the graphs. The family graphs Defaults to NULL. |
family_graphs_col |
Name of column with family graphs in family_graphs. Defaults to "fam_graph". |
pid |
A string holding the name of the column in |
fid |
A string holding the name of the column in |
role |
A string holding the name of the column in
Defaults to "role". |
dadcol |
column name of father in family_graphs or .tbl. |
momcol |
column name of mother in family_graphs or .tbl. |
env_cor_sib |
Cohabitation effect, i.e. Factor by which the siblings are weighted. Defaults to 1. |
env_cor_f |
Cohabitation effect, i.e. Factor by which the father is weighted. Defaults to 1. |
env_cor_m |
Cohabitation effect, i.e. Factor by which the mother is weighted. Defaults to 1. |
The coding of the cohabitation effects differ slightly from the one suggested by Kendler et al. Here, it is coded as env_cor_\* = env_eff_\* / (gen_eff_\* + env_eff_\*), while the original implementation suggestes coding it as gen_eff_\* / (gen_eff_\* + env_eff_\*), i.e. the two are related as 1 - env_cor_\*.
A tibble with summary values used to calculate the simplified kendler FGRS and the FGRS itself.
# See Vignettes.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.