error_df-pHSensor-method: Finds the error df of this pH sensor at given inaccuracies

Description Usage Arguments Value Examples

Description

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

Usage

1
2
3
4
5
6
7
8
9
## S4 method for signature 'pHSensor'
error_df(
  object,
  inaccuracies = c(0.01),
  pHmin = 1,
  pHmax = 14,
  by = 0.001,
  name = "Sensor"
)

Arguments

object

A pHSensor object

inaccuracies

(optional, default: c(0.01)) A vector of inaccuracies (e.g. 0.02 for 2% error), always relative

pHmin

(optional, default: 1) The minimum pH for which to record error

pHmax

(optional, default: 14) The maximum pH 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

Value

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

Examples

1
2
3
4
my_sensor <- new("pHSensor", new("Sensor", Rmin = 1, Rmax = 5, delta = 0.2), pKa = 7)
error_df(my_sensor,
  inaccuracies = c(0.01, 0.02), pHmin = 1, pHmax = 14,
)

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