get.x.name: Get the original x-variable

View source: R/electrophoresis.R

get.x.nameR Documentation

Get the original x-variable

Description

This function takes an electrophoresis object and returns the name of the x-variable that was used to fit the mobility model.

Usage

get.x.name(electrophoresis, raw = FALSE, allow.multiple = FALSE)

Arguments

electrophoresis

An electrophoresis object.

raw

Whether to return the name of the raw variable instead of the aligned variable.

allow.multiple

Whether to allow multiple raw variables (data combined from multiple platforms).

Details

If 'raw == FALSE' the result should only be either "aligned time" for Bioanalyzer data or "relative.distance" for TapeStation data. If 'raw == TRUE' the result should be "time" or "distance".

Value

A character giving the name of the x-variable.


jwfoley/bioanalyzeR documentation built on Aug. 1, 2023, 4:46 a.m.