error_df-redoxSensor-method: Finds the error df of this redox sensor at given inaccuracies

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 'redoxSensor'
error_df(
  object,
  inaccuracies = c(0.02),
  Emin = -400,
  Emax = -200,
  temp = 295.15,
  by = 0.01,
  name = "Sensor"
)

Arguments

object	A redoxSensor object
inaccuracies	(optional, default: c(0.02)) A vector of inaccuracies (e.g. 0.02 for 2% error), always relative
Emin	(optional, default: -400) The minimum redox potential, in mV, for which to record error
Emax	(optional, default: -200) The maximum redox potential, in mV, for which to record error
temp	(optional, default: 295.15) the temperature (in Kelvin) at which measurements were made
by	(optional, default: 0.01) The granularity of the error table–e.g., by = 0.01 would record 275 and 275.01, etc.
name	(optional, default: "Sensor") A name for this sensor

Value

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

Examples

my_sensor <- new("redoxSensor", new("Sensor", Rmin = 1, Rmax = 5, delta = 0.2), e0 = -250)
error_df(my_sensor,
  inaccuracies = c(0.01, 0.02), Emin = -300, Emax = -200,
)

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