dataType: dataType R6 class.

dataTypeR Documentation

dataType R6 class.

Description

Inherits: rdmlBaseType.

Format

An R6Class generator object.

Initialization

dataType$new(tar, cq = NULL, excl = NULL,
adp = NULL, mdp = NULL, endPt = NULL, bgFluor = NULL, bgFluorSlp = NULL,
quantFluor = NULL)

Fields

tar

idReferencesType. TargetID - A reference to a target.

cq

checkNumber. Calculated fractional PCR cycle used for downstream quantification. Negative values express following condition: Not Available: -1.0 . (can be NaN for BioRad Maestro compatibility)

excl

checkString. Excluded. If excl is present, this entry should not be evaluated. Do not set this element to FALSE if the entry is valid. Instead, leave the entire excl element out instead. It may contain a string with a reason for the exclusion. Several reasons for exclusion should be seperated by semicolons ";".

adp

adpsType.

mdp

mdpsType.

endPt

checkNumber

. Value of the endpoint measurement.

bgFluor

checkNumber. Background fluorescence (the y-intercept of the baseline trend based on the estimated background fluorescence).

bgFluorSlp

checkNumber. Background fluorescence slope - The slope of the baseline trend based on the estimated background fluorescence. The element should be absent to indicate a slope of 0.0; If this element is present without the bgFluor element it should be ignored.

quantFluor

checkNumber. Quantification flourescence - The fluorescence value corresponding to the treshold line.

Methods

AsDataFrame(dp.type = "adp")

Represents amplification (

dp.type = "adp"

) or melting (dp.type = "mdp") data points as data.frame

Super class

RDML::rdmlBaseType -> dataType

Methods

Public methods

Inherited methods

Method new()

Usage
dataType$new(
  tar,
  cq = NULL,
  excl = NULL,
  adp = NULL,
  mdp = NULL,
  endPt = NULL,
  bgFluor = NULL,
  bgFluorSlp = NULL,
  quantFluor = NULL
)

Method GetFData()

Usage
dataType$GetFData(dp.type = "adp")

Method clone()

The objects of this class are cloneable with this method.

Usage
dataType$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


kablag/RDML documentation built on Oct. 20, 2022, 5:47 a.m.