strvalidator (version 2.3.0)

getKit: Get Kit

Description

Provides information about STR kits.

Usage

getKit(
  kit = NULL,
  what = NA,
  show.messages = FALSE,
  .kit.info = NULL,
  debug = FALSE
)

Value

data.frame with kit information.

Arguments

kit

string or integer to specify the kit.

what

string to specify which information to return. Default is 'NA' which return all info. Not case sensitive. Possible values: "Index", "Panel", "Short.Name", "Full.Name", "Marker, "Allele", "Size", "Virtual", "Color", "Repeat", "Range", "Offset", "Sex.Marker", "Quality.Sensor". An unsupported value returns NA and a warning.

show.messages

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

.kit.info

data frame, run function on a data frame instead of the kits.txt file.

debug

logical indicating printing debug information.

Details

The function returns the following information for a kit specified in kits.txt: Panel name, short kit name (unique, user defined), full kit name (user defined), marker names, allele names, allele sizes (bp), minimum allele size, maximum allele size (bp), flag for virtual alleles, marker color, marker repeat unit size (bp), minimum marker size, maximum marker, marker offset (bp), flag for sex markers (TRUE/FALSE).

If no matching kit or kit index is found NA is returned. If kit='NULL' or '0' a vector of available kits is printed and NA returned.

Examples

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