error_df-ligandSensor-method: Finds the error df of this ligand sensor at given...

In julianstanley/SensorOverlord: A Tyrant of Absolute Quantitative Ratiometric Microscopy

Description

Adding this method on 31 May 2020, hoping this style will depreciate getErrorTable in the future.

Usage

## S4 method for signature 'ligandSensor'
error_df(
  object,
  inaccuracies = c(0.01),
  pLigand_min = 1,
  pLigand_max = 14,
  by = 0.001,
  name = "Sensor"
)

Arguments

object	A ligandSensor object
inaccuracies	(optional, default: c(0.01)) A vector of inaccuracies (e.g. 0.02 for 2% error), always relative
pLigand_min	(optional, default: 1) The minimum pLigand for which to record error
by	(optional, default: 0.001) The granularity of the error table–e.g., by = 0.01 would record 7 and 7.01, etc.
name	(optional, default: "Sensor") A name for this sensor
pLigandmax	(optional, default: 14) The maximum pLigand for which to record error

Value

A dataframe of errors with columns: 'Name': this sensor name 'pLigand': the pLigand, 'Rmin': the minimum possible ratiometric fluorescence for this sensor 'Rmax': the maximum possible ratiometric fluorescence for this sensor 'Error': the error in this pLigand 'Inaccuracy': The inaccuracy of the measurements (relative to R).

Examples

my_sensor <- new("ligandSensor", new("Sensor", Rmin = 1, Rmax = 5, delta = 0.2),
pKd = 7, ligand_name = "NADPH")
error_df(my_sensor,
  inaccuracies = c(0.01, 0.02), pLigand_min = 1, pLigand_max = 14,
)

julianstanley/SensorOverlord documentation built on Oct. 19, 2020, 2:29 p.m.