addBarcodes {OmicNavigator}

Add barcode plot metadata

Description

The app can display a barcode plot of the enrichment results for a given annotation term. The metadata in 'barcodes' instructs the app how to create and label the barcode plot.

Usage

addBarcodes(study, barcodes, reset = FALSE)

Arguments

study

An OmicNavigator study created with createStudy

barcodes

The metadata variables that describe the barcode plot. The input object is a list of lists (one per model). Each sublist must contain the element statistic, which is the column name in the results table to use to construct the barcode plot. Each sublist may additionally contain any of the following optional elements: 1) absolute - Should the statistic be converted to its absolute value (default is TRUE). 2) logFoldChange - The column name in the results table that contains the log fold change values. 3) labelStat - The x-axis label to describe the statistic. 4) labelLow - The left-side label to describe low values of the statistic. 5) labelHigh - The right-side label to describe high values of the statistic. 6) featureDisplay - The feature variable to use to label the barcode plot on hover. To share metadata across multiple models, use the modelID "default".

reset

Reset the data prior to adding the new data (default: FALSE). The default is to add to or modify any previously added data (if it exists). Setting reset = TRUE enables you to remove existing data you no longer want to include in the study.

Value

Returns the original onStudy object passed to the argument study, but modified to include the newly added data