fmn_siblings: Determine who are siblings using only ID, mother ID, and...

In lwjohnst86/famnet: Characterizing a Family Network

Description

This function is best used with data on a very large population, that has information on an individual as well as that person's parent's IDs. Common datasets with this information would be population level register databases, such as found in Denmark or Sweden.

Usage

fmn_siblings(.data, .personid, .motherid, .fatherid)

fmn_siblings_tv(.data, .personid, .motherid, .fatherid)

fmn_siblings_dt(.data, .personid, .motherid, .fatherid)

Arguments

.data	Data that contains columns of persons IDs, for the individual, mother, and father.
.personid	Column with main person's ID.
.motherid	Column with person's mother's ID.
.fatherid	Column with person's father's ID.

Value

A dataset with at least:

• PersonID: An individual's ID

• RelativeID: An ID of one of the individual's relative or family member

• RelativeType: The type of relationship between the person and the relative

Functions

• fmn_siblings_tv: Function to determine sibling relationships, using "tidyverse" functions (e.g. dplyr).

• fmn_siblings_dt: Function to determine sibling relationships using data.table functions.

Examples

# Uses tidyverse under the hood. There is a data.table version available.
fmn_siblings(fmn_df, "PersonID", "MotherID", "FatherID")

lwjohnst86/famnet documentation built on May 30, 2019, 11:41 p.m.