compute_metrics: Compute Metrics

View source: R/compute_metrics.R

compute_metricsR Documentation

Compute Metrics

Description

This function computes the metrics that will be then used to compute the z-score using the function find_zscore_hit starting from the screenr object for a given treatment in a given day. More information about the z-score and other metrics used in genetic screening can be found at this paper z-score

Usage

compute_metrics(screenR_Object, control, treatment, day)

Arguments

screenR_Object

The ScreenR object obtained using the create_screenr_object

control

A string specifying the sample that as to be used as control in the analysis. This string has to be equal to the interested sample in the Treatment column of the data_table slot

treatment

A string specifying the sample that as to be used as treatment in the analysis. This string has to be equal to the interested sample in the Treatment column of the data_table slot.

day

A string containing the day (time point) to consider in the metrics computation. This string has to be equal to the interested sample in the Day column of the data_table slot.

Value

Return a tibble with all the measure computed.

Examples

object <- get0("object", envir = asNamespace("ScreenR"))
metrics <- compute_metrics(object,
    control = "TRT",
    treatment = "Time3", day = "Time3"
)
head(metrics)

EmanuelSoda/ScreenR documentation built on Sept. 29, 2023, 12:33 a.m.