sink_rate: Calculate cell sinking rates from segmented regression...

Description Usage Arguments Value Note Examples

View source: R/sink rate.R

Description

Uses segmented regression parameters to estimate cell sinking rates. For a given well, a sinking rate in millimeters per minute is computed for each segment of the regression model (i.e., 3 rates per well). It is then up to the user to select which of the three sinking rates best represents the data. Sinking rates are calculated as follows: sinking rate = slope/(y-intercept - well bottom) * sample depth

Usage

1
sink_rate(database_fits, sample_depth = 3.8, export_output = FALSE, save_as = "Sinking_Rates.csv")

Arguments

database_fits

dataframe containing the segmented regression parameters that will be used to calculate sinking rate. Generated by running sink_fit().

sample_depth

height of sample in the well,in mm. Depends on the sample volume and plate size; for 300 uL samples in 96-well plates, the sample depth is 3.8 mm.

export_output

whether the resulting dataframe should be exported to .csv.

save_as

desired filename, if results are to be exported.

Value

A dataframe containing sinking rate estimates, with each row representing a single well. A rate will be calculated for each segment of the regression (i.e., each slope will have a corresponding sinking rate). 95

Note

Rates cannot be estimated without obtaining the segmented regression parameters first. There is currently no screening process in place to select the most representative sinking rate across wells/replicates, so it remains up to the user to select the rates they wish to compare across samples. It is also worth noting that sinking rates of samples with different sample depths must be estimated separately.

Examples

1
2
3
4
5
rates <- sink_rate(sinking_fits, sample_depth = 5, export_output = T, save_as = "Sink_Rates")

sink_rate(sinking_fits, export_output = T, save_as = "Sink_Rates")

rates <- sink_rate(sinking_fits)

mlrioux/sinkworx documentation built on June 2, 2020, 10:28 p.m.