strvalidator (version 0.3.0)

getKit: Get kit

Description

getKit provides information about STR kits.

Usage

getKit(kitNameOrIndex = NULL, showMessages = FALSE,
    .kitInfo = NULL, debug = FALSE)

Arguments

kitNameOrIndex

string or integer specifying the kit.

showMessages

logical, default TRUE for printing messages to the R promt.

debug

logical indicating printing debug information.

Value

• list with kit information.

Details

The function returns the following information for a kit specified in kits.txt: Short kit name, Full kit name, Marker/locus names, Dye for each marker/locus, Start offset (in base pairs) for each marker, Size of repeating unit (in base pairs) for each marker. If no matching kit or kit index is found NA is returned. If NULL a vector of available kits is printed and NA returned.

Examples

# Show all information stored for kit with short name 'ESX17'.
getKit("ESX17")