beadarrayUsersGuide: View beadarray User's Guide

Description Usage Arguments Details Value Author(s) Examples

View source: R/miscFunctions.R

Description

Finds the location of the beadarray User's Guide and opens it.

Usage

1
beadarrayUsersGuide(view=TRUE, topic="beadlevel")

Arguments

view

logical, should the document be opened using the default PDF document reader? (default is TRUE)

topic

character string specifying topic ("beadlevel", "beadsummary" or "BASH")

Details

The function vignette("beadarray") will find the short beadarray vignette which describes how to obtain the more detailed user's guide on the analysis of raw "beadlevel" data, "beadsummary" data or how to use the "BASH" method for detecting spatial artefacts.

Value

Character string giving the file location.

Author(s)

Matt Ritchie

Examples

1
2
beadarrayUsersGuide(view=FALSE)
beadarrayUsersGuide(view=FALSE, topic="beadsummary")

beadarray documentation built on Nov. 8, 2020, 4:51 p.m.