calculateResultType: Calculate Result Type

View source: R/calculateResultType.r

calculateResultTypeR Documentation

Calculate Result Type

Description

Calculate the result type for samples.

Usage

calculateResultType(
  data,
  kit = NULL,
  add.missing.marker = TRUE,
  threshold = NULL,
  mixture.limits = NULL,
  partial.limits = NULL,
  subset.name = NA,
  marker.subset = NULL,
  debug = FALSE
)

Arguments

data

a data frame containing at least the column 'Sample.Name'.

kit

character string or integer defining the kit.

add.missing.marker

logical, default is TRUE which adds missing markers.

threshold

integer indicating the dropout threshold.

mixture.limits

integer or vector indicating subtypes of 'Mixture'.

partial.limits

integer or vector indicating subtypes of 'Partial'.

subset.name

string naming the subset of 'Complete'.

marker.subset

string with marker names defining the subset of 'Complete'.

debug

logical indicating printing debug information.

Details

Calculates result types for samples in 'data'. Defined types are: 'No result', 'Mixture', 'Partial', and 'Complete'. Subtypes can be defined by parameters. An integer passed to 'threshold' defines a subtype of 'Complete' "Complete profile all peaks >threshold". An integer or vector passed to 'mixture.limits' define subtypes of 'Mixture' "> [mixture.limits] markers". An integer or vector passed to 'partial.limits' define subtypes of 'Partial' "> [partial.limits] peaks". A string with marker names separated by pipe (|) passed to 'marker.subset' and a string 'subset.name' defines a subtype of 'Partial' "Complete [subset.name]".

Value

data.frame with columns 'Sample.Name','Type', and 'Subtype'.


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