get_marker_kit: Standard Amplification Kits

In knifecake/fafreqs: Common Frequency Databases for Forensic Markers

Description

This function returns information about the most comonly used amplification kits. The abbrev and name params allow the user to search for kits in this package. The just_names param controls the output of the function. If no parameters are provided, it returns a list of all the kits that this package includes.

Usage

get_marker_kit(abbrev = NULL, name = NULL, just_names = FALSE)

Arguments

abbrev	abbreviation code for the kit
name	name of the kit
just_names	wether to return the abbreviation of the matching kits in a named list or just the list of markers amplified by that kit.

Value

a (list of) kit which consists in a list of markers (if just_names = FALSE) or the abbreviation of the kit. If multiple kits match or no filtering parameters were provided a list of kits is returned.

Examples

# get a list of the names of all the available kits
get_marker_kit(just_names = TRUE)

# get the markers included in the "Qiagen Investigator HDplex" kit
get_marker_kit(name = "Qiagen Investigator HDplex")

# get the markers included in the "core23" (abbrev) kit
# this is useful for when you know the abbreviation
# of a kit which is shorter to type
get_marker_kit(abbrev = "core23")

knifecake/fafreqs documentation built on March 13, 2020, 11:53 p.m.