generate.plot.covariates: Generate plot covariate object

View source: R/generate.plot.covariates.R

generate.plot.covariatesR Documentation

Generate plot covariate object

Description

Generate a covariate object for plotting purposes

Usage

generate.plot.covariates(plotting.data, sample.covariates = NULL, gene.covariates = NULL)

Arguments

plotting.data

A matrix or data-frame that contains the main plotting data. Sample IDs are expected for column names

sample.covariates

A sample by covariate data-frame. Currently only accepts sample covariates 'Type' and 'Cartridge'. Must also contain a 'SampleID' column to match to 'nano.counts' sample IDs. Defaults to NULL

gene.covariates

A gene by covariate data-frame. Currently only accepts gene covariate 'CodeClass'. A 'Name' column is mandatory to match to 'nano.counts' gene probe names. Defaults to NULL

Details

Called by visualize.results, this function creates a covariate annotate (as a fully formed list) that can be passed onto a plot

Value

A list of 2 sub-lists that contain border colour and fill colour information for 1) sample covariates and 2) gene covariates

Author(s)

Dorota Sendorek and Emilie Lalonde

See Also

NanoStringNormCNV:::generate.plot.legend


uclahs-cds/public-R-NanoStringNormCNV documentation built on May 31, 2024, 9:09 p.m.