estimate_barcode_threshold {barcodetrackR} | R Documentation

## Estimate Barcode Threshold

### Description

Estimates an appropriate minimum abundance threshold for reliably detected barcodes in a clonal tracking dataset.
For a specified capture efficiency C, the minimum clone size N that we can expect to detect with confidence level P is calculated from:
'P = 1 - (1 - C)^(N)'
The proportional abundance of a clonal tag of size N is
'N / (T * F)'
where T is the total population size of cells or genomes and F is the frequency or proportion of the total population which is labeled or genetically modified with the clonal tag.
The population size and proportion labeled must be determined experimentally. The capture efficiency should be estimated for a given clonal tracking technique by simulating the barcode retrieval process in silico and finding the capture efficiency which leads to a total # of detected barcodes matching the experimentally determined number. Adair et al '(PMID: 32355868)' performed this analysis for viral integration site analysis and DNA barcode sequencing and determined good estimates for the capture efficiencies of these two technologies to be 0.05 and 0.4 respectively.

### Usage

    estimate_barcode_threshold(
      capture_efficiency = NULL,
      population_size,
      proportion_labeled,
      confidence_level = 0.95,
      verbose = TRUE
    )

### Arguments

`capture_efficiency` | Numeric. The capture efficiency of the clonal tracking method to detect a given clone. Must be between 0 and 1. See the description for details on how to estimate this value for a given experiment.
`population_size` | Numeric. The total number of cells/genomes within each sample analyzed in the clonal tracking study. This is an experimentally determined value.
`proportion_labeled` | Numeric. The proportion of the 'population_size' which is genetically modified or contains a clonal tracking index. This is an experimentally determined value.
`confidence_level` | Numeric. The confidence level for estimatig the minimum abundance threshold. Must be between 0 and 1. Default is 0.95 for 95 percent confidence that a clone with proportion 'relative_threshold' will be detected. Increasing this parameter closer to one will result in a more stringent abundance threshold and decreasing this parameter will result in a more permissive abundance threshold.
`verbose` | Logical. Whether to print the calculated threshold.

### Value

Returns a single numeric 'relative_threshold' describing the proportional abundance above which clones can be considered reliable given the provided capture efficiency and labeled population size. Pass this value into the function 'threshold_SE' to threshold an existing SummarizedExperiment object or the function 'create_SE' to threshold a SummarizedExperiment object upon creation from dataframes of counts and metadata.

### Examples

    estimate_barcode_threshold(
        capture_efficiency = 0.4,
        population_size = 500000,
        proportion_labeled = 0.3,
        confidence_level = 0.95,
        verbose = TRUE
    )

[Package barcodetrackR version 1.0.0 Index]