Package 'NGCHMSupportFiles'

Title: Support Files for Building Next Generation Clustered Heat Maps (NG-CHMs)
Description: Support files required by the 'NGCHM' package to export Next-Generation Clustered Heat Maps (NG-CHMs) to .ngchm, HTML, and PDF files. These support files are updated mostly independently from the 'NGCHM' package, and are therefore provided separately.
Authors: Bradley M Broom [aut] , Mary A Rohrdanz [ctb, cre], Chris Wakefield [ctb], James Melott [ctb], Mark Stucky [aut], Michael Ryan [aut], Futa Ikeda [ctb], MD Anderson Cancer Center [cph]
Maintainer: Mary A Rohrdanz <[email protected]>
License: GPL-3
Version: 2.24.4
Built: 2024-07-20 05:40:21 UTC
Source: https://github.com/MD-Anderson-Bioinformatics/NGCHMSupportFiles

Help Index


Support Files for Building Next Generation Clustered Heat Maps (NG-CHMs)

Description

Support Files for 'NGCHM' package

Details

Files provided by this package:

  • ShaidyMapGen.jar - Compiled Java code. Used by NGCHM::chmExportToFile(),
    NGCHM::chmExportToHTML(), NGCHM::chmExportToPDF() to produce .ngchm, .html, and .pdf files, respectively.

  • ngchmWidget-min.js - JavaScript library used to display NG-CHMs in a web browser. Used by NGCHM::chmExportToHTML().

These Support Files are made available to the 'NGCHM' package via environment variables, SHAIDYMAPGEN and NGCHMWIDGETPATH, which are set when this package loads. These files are required to export a Next-Generation Clustered Heat Map (NG-CHM) to a .ngchm, .html, or .pdf file.

Installation

This package can be installed from MD Anderson Bioinformatics R-universe repository:

install.packages("NGCHMSupportFiles",
repos = c("https://md-anderson-bioinformatics.r-universe.dev", "https://cran.r-project.org"))

Author(s)

Maintainer: Mary A Rohrdanz [email protected] [contributor]

Authors:

Other contributors:

See Also

Useful links:


Display message regarding environment variables

Description

Display message to user that environment variables were set for:

  • SHAIDYMAPGEN - Path to the included file ShaidyMapGen.jar

  • NGCHMWIDGETPATH - Path to the included file ngchmWidget-min.js

Usage

.onAttach(libname, pkgname)

Arguments

libname

name of the library

pkgname

name of the package


Define environment variables

Description

Define environment variables:

  • SHAIDYMAPGEN - Path to the included file ShaidyMapGen.jar

  • NGCHMWIDGETPATH - Path to the included file ngchmWidget-min.js

Usage

.onLoad(libname, pkgname)

Arguments

libname

name of the library

pkgname

name of the package