rank_mates: Rank Mates

In danagibbon/MultifacitedChoice:

Description

Wrapper function to score the mating of a single female to all males.
Apply this function to multiple females using the get_all_rankings function.
This functions sorts the output dataframe by highest scoring male.

Usage

rank_mates(
  DB,
  female,
  males,
  type = "all_alleles",
  bonus = NULL,
  weighted_alleles = NULL
)

Arguments

DB	RSQLite database generated by make_database
female	Sample ID of the female to compare to the males. The Sample ID must match the ones found in the DB.
males	Sample IDs of the males to compare to a female. The Sample IDs must match the ones found in the DB.
type	The type of mating that is advantageous. all_alleles: the user specifies for each locus what is advantageous. assortive: Assortive (same alleles) is advantageous for all loci disassortive: Disassortive (different alleles) is advantageous for all loci
bonus	Numeric value to increase mating score if the state of alleles specified in weighted_alleles are met. If you specify .15 as your bonus, and 2/3 of your loci match the advantageous, then .10 will be used as the bonus. The final score will be increased by 10%. Must specify weighted_alleles.
weighted_alleles	vector listing allele IDs to calculate the bonus. Must specify bonus.

Value

dataframe

Examples

## Not run: 
female_mates <- rank_mate(DB = DB, female = females[1],
                          males = males, type = "all_alleles",
                          bonus=NULL, weighted_alleles=NULL)

## End(Not run)

danagibbon/MultifacitedChoice documentation built on Dec. 31, 2020, 11:10 p.m.