ranges_df-redoxSensor-method: Finds the ranges df of this redox 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 'redoxSensor'
ranges_df(
  object,
  inaccuracies = c(0.02),
  Emin = -400,
  Emax = -200,
  temp = 295.15,
  by = 0.01,
  name = "Sensor",
  thresholds = c(0.5, 1, 1.5, 2, 2.5)
)

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
thresholds	A vector of error thresholds (e.g. c(0.5, 1) for 0.5mV and 1mV)

Value

A dataframe of suited ranges with these columns: 'Sensor_Name': the name of the sensor 'Minimum': the minimum redox potential (mV) measurable at the given inaccuracy 'Maximum': the maximum redox potential (mV) measurable at the given inaccuracy 'Inaccuracy': the inaccuracy associated with this row (relative) 'error_thresh': the error threshold associated with this row (mV)

Examples

my_sensor <- new("redoxSensor", new("Sensor", Rmin = 1, Rmax = 5, delta = 0.2), e0 = -250)
ranges_df(my_sensor)

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