get_cvg_stats,Primers-method {openPrimeR} | R Documentation

## Coverage Statistics of a Primer Set.

### Description

Retrieve statistics on the templates that are covered by a primer set.

### Usage

    ## S4 method for signature 'Primers'
    get_cvg_stats(
      primers,
      templates,
      for.viewing = FALSE,
      total.percentages = FALSE,
      allowed.mismatches = Inf,
      cvg.definition = c("constrained", "basic")
    )

### Arguments

`for.viewing` | Whether the table should be formatted for viewing rather than processing.
`total.percentages` | Whether group coverage percentages should relate to all template sequences or just those templates belonging to a specific group.
`allowed.mismatches` | The maximal allowed number of mismatches. By default, the number of mismatches is not restricted.
`cvg.definition` | If `cvg.definition` is set to "constrained", the statistics for the expected coverage (after applying the coverage constraints) are retrieved. If `cvg.definition` is set to "basic", the coverage is determined solely by string matching (i.e. without applying the coverage constraints). By default, `cvg.definition` is set to "constrained".
`primer.df` | An object of class `Primers` containing primers with evaluated coverage.
`template.df` | An object of class `Templates` containing templates with evaluated coverage.

### Value

Data frame with coverage statistics.

[Package openPrimeR version 1.16.0 Index]