create_report-Primers-Templates-method: Creation of a PDF report.

In matdoering/openPrimeR: Multiplex PCR Primer Design and Analysis

Creation of a PDF report.

Description

Creates a PDF report for a set of primers.

Usage

## S4 method for signature 'Primers,Templates'
create_report(
  primers,
  templates,
  fname,
  settings,
  sample.name,
  used.settings,
  required.cvg = 1
)

Arguments

primers	An evaluated Primers object.
templates	A Templates object.
fname	A character vector giving the file to store the report in.
settings	A DesignSettings object.
sample.name	An identifier for your analysis.
used.settings	A named list (with fields "fw" and "rev") containing the forward/reverse used design settings.
required.cvg	The required coverage ratio.

Value

Creates a PDF file reporting on the input primers.

Note

Creating the report requires the external programs Pandoc (http://pandoc.org) and LaTeX (http://latex-project.org).

matdoering/openPrimeR documentation built on Feb. 11, 2024, 9:22 p.m.