getColours-methods: Work with objects of class PwfCols

In steveped/ngsReports: Load FastqQC reports and other NGS related files

Work with objects of class PwfCols

Description

Get and modify colours from objects of class PwfCols

Usage

## S4 method for signature 'PwfCols'
getColours(object)

## S4 method for signature 'PwfCols'
setColours(object, PASS, WARN, FAIL, MAX)

## S4 method for signature 'PwfCols'
setAlpha(object, alpha)

Arguments

object	An object of class PwfCols
PASS	The colour denoting PASS on all plots, in rgb format
WARN	The colour denoting WARN on all plots, in rgb format
FAIL	The colour denoting FAIL on all plots, in rgb format
MAX	The colour denoting the limit of values in rgb format
alpha	Numeric(1). Ranges from 0 to 1 by default, but can also be on the range 0 to 255.

Details

Use getColours to obtain the colours in an object of class PwfCols.

These can be modified using the functions setColours and setAlpha

Value

getColours will return a character vector of colours coresponding to PASS/WARN/FAIL

setColours will return an object of class PwfCols

setAlpha will return an object of class PwfCols

Examples

getColours(pwf)

# How to add transparency
pwf2 <- setAlpha(pwf, 0.1)
getColours(pwf2)

steveped/ngsReports documentation built on July 24, 2024, 10:45 a.m.