pcrsim (version 1.0.2)

getParameter: Get Kit Parameters

Description

Provides parameters for simulation for different STR kits and methods.

Usage

getParameter(kit = NULL, what = NA, method = NA, show.messages = FALSE,
  .kit.param = NULL, debug = FALSE)

Arguments

kit

string or integer specifying the kit.

what

string to specify which information to return. Default is 'NA' which return all info. Not case sensitive.

method

string to specify which method to return. Default is 'NA' which return all info. Not case sensitive.

show.messages

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

.kit.param

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

debug

logical indicating printing debug information.

Value

vector of data frame with kit information.

Details

The function returns various information for kit and parameters specified in parameters.txt.

Examples

# Returns vector of available kits.
getParameter()

# Returns vector of all methods.
getParameter(what="methods")

# Returns methods for specified kit.
getParameter(kit="SGMPlus", what="methods")

# Returns vector of available options.
getParameter(what="options")

# Returns vector of markers for specified kit.
getParameter(kit="SGMPlus", what="Marker")

# Returns data frame of all information for specified kit and method.
getParameter(kit="SGMPlus", method = "Default")