addOrder: Add Marker Order.

View source: R/addOrder.r

addOrderR Documentation

Add Marker Order.

Description

Add marker order to data frame containing a column 'Marker'.

Usage

addOrder(
  data,
  kit = NULL,
  overwrite = FALSE,
  ignore.case = FALSE,
  debug = FALSE
)

Arguments

data

data frame or vector.

kit

string representing the forensic STR kit used. Default is NULL and automatic detection of kit will be attempted.

overwrite

logical if TRUE and column exist it will be overwritten.

ignore.case

logical if TRUE case in marker names will be ignored.

debug

logical indicating printing debug information.

Details

Markers in a kit appear in a certain order. Not all STR-validator functions keep the original marker order in the result. A column indicating the marker order is added to the dataset. This is especially useful when exporting the data to an external spread-sheet software and allow to quickly sort the data in the correct order.

Value

data.frame with additional numeric column 'Order'.

Examples

# Load a dataset containing two samples.
data("set2")
# Add marker order when kit is known.
addOrder(data = set2, kit = "SGMPlus")

OskarHansson/strvalidator documentation built on July 22, 2023, 12:04 p.m.