create_legend: This function reads a CMAPResults object and returns the html...

Description Usage Arguments Value Author(s)

View source: R/reporting.R

Description

This function reads a CMAPResults object and returns the html code to display a legend for all columns that have more descriptive annotations in the varMetadata slot. A standard set of columns is selected for display in the legend through the 'keep' parameter. In addition, all columns with annotations in the labelDescription field of the varMetadata slot are included if the field content differs from the column name.

Usage

1
2
3
create_legend(res, reference.name, keep = c("set", "trend", "FDR", "effect",
  "nSet", "Genes"), swap.colnames = getOption("swap.colnames", default =
  list(padj = "FDR", nFound = "Genes")))

Arguments

res

CMAPResults object

reference.name

character, ame of the reference database used

keep

character, a vector with column names that are always included in the legend

swap.colnames

list, containing alternative names for CMAPResults columns.

Value

character string with the html code element required to insert the legend into the html report

Author(s)

Thomas Sandmann



gCMAPWeb documentation built on May 20, 2017, 9:42 p.m.
Search within the gCMAPWeb package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.