famSearch: Search a database for siblings or children
In jmcurran/relSim: Relative Simulator

famSearch

R Documentation

Search a database for siblings or children

Description

This function searches a database of profiles for either a sibling or a child

Usage

famSearch(profiles, siblings, children, listFreqs, step)

Arguments

`profiles`	an integer vector of stacked profiles representing the database. This vector has `2NL` entries, where N is the number of profiles and L is the number of loci.
`siblings`	an integer vector of stacked profiles representing the siblings of the profiles in database. The first entry is a sibling of the first entry in `profiles` and so on. This vector has `2NL` entries, where N is the number of profiles and L is the number of loci.
`children`	an integer vector of stacked profiles representing the children of the profiles in database. The first entry is a child of the first entry in `profiles` and so on. This vector has `2NL` entries, where N is the number of profiles and L is the number of loci.
`listFreqs`	is a set of allele frequencies representing a particular multiplex. The function assumes that that loci in the profiles are in the same order as the loci in this list. The data structure is a `List` of `NumericVector`'s.
`step`	A step size for progress reporting, i.e. print out progress every `step` iterations. If `step = -1`, then there is no printing.

Value

a List containing two dataframes, one called sibs and one called children. Each dataframe has results from searching for either the sibling or the child in the database. For each entry there is a record of which profile gave the highest LR (and its value), and the position of the actual sibling or parent/child in the database (and its respective LR).