check_sibling_order: Check Sibling Order

View source: R/helpers_regression.R

check_sibling_orderR Documentation

Check Sibling Order

Description

This function determines the order of sibling pairs based on an outcome variable. It function checks which of the two kinship pairs has more of a specified outcome variable. It adds a new column named 'order' to the dataset, indicating which sibling (identified as "s1" or "s2") has more of the outcome. If the two siblings have the same amount of the outcome, it randomly assigns one as having more.

Usage

check_sibling_order(data, outcome, pair_identifiers, row)

Arguments

data

The data set with kinship pairs

outcome

A character string containing the outcome variable of interest.

pair_identifiers

A character vector of length two that contains the variable identifier for each kinship pair

row

The row number of the data frame

Value

A character string signifying which familial member (1, 2, or neither) has more of the outcome.


smasongarrison/discord documentation built on March 4, 2024, 12:55 p.m.