beadarrayUsersGuide {beadarray} | R Documentation

## View beadarray User's Guide

### Description

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

### Usage

    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

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

[Package beadarray version 2.36.1 Index]