create_report-list-list-method: Creation of a PDF Report for Primer Comparison.

create_report,list,list-methodR Documentation

Creation of a PDF Report for Primer Comparison.

Description

Creates a PDF report for comparing multiple primers.

Usage

## S4 method for signature 'list,list'
create_report(
  primers,
  templates,
  fname,
  settings,
  sample.name = NULL,
  used.settings = NULL
)

Arguments

primers

A list with evaluated Primers objects.

templates

A list with Templates objects.

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.

Value

Creates a PDF file giving a report on the comparison of 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.