NGCHM1.0.4 package

Next Generation Clustered Heat Maps

addition-methods

Add an Axis to an NG-CHM Version 2

cash-.shaidyRepo

Provide a simpler method for accessing repo methods

castAsInteger

Helper function to cast variables as integers.

castListAsInteger

Helper function to cast list as integer

chmAdd-method

Add a list of objects to a NGCHM.

chmAddAxisType-method

Add an axis type to a NGCHM.

chmAddColormap-method

Add a colormap to a NGCHM.

chmAddCovariate-method

Add a covariate to an auxiliary dataset.

chmAddCovariateBar-method

Add a covariate bar to a NGCHM.

chmAddCSS-method

Add custom CSS to a NGCHM.

chmAddDataset-method

Add an auxiliary dataset to a NGCHM.

chmAddDialog-method

Add an extra dialog to a NGCHM.

chmAddLayer-method

Add a Layer to a NGCHM.

chmAddMenuItem-method

Add a menu entry to a NGCHM.

chmAddMetaData-method

Add MetaData to NG-CHM

chmAddOverview-method

Generate an overview image of the NGCHM when making it.

chmAddPCA

Add PCA coordinates to an NG-CHM.

chmAddProperty-method

Add custom property to a NGCHM.

chmAddReducedDim

Add reduced dimension coordinates to an NG-CHM.

chmAddRelated-method

Add a link to related information to the NGCHM.

chmAddRelatedGroup-method

Add a group of related links to the NGCHM.

chmAddSpecificAxisTypeFunction-method

Add a CHM-specific axis type function to a NGCHM.

chmAddTag-method

Add tags to a NGCHM.

chmAddTemplate-method

Add a file template to the NGCHM.

chmAddToolboxR-method

Add standard toolbox to an NG-CHM axis

chmAddToolboxR2-method

Add Toolbox R2 to NG-CHM

chmAddToolboxRC-method

Add Toolbox RC to NG-CHM

chmAddTSNE

Add TSNE coordinates to an NG-CHM.

chmAddUMAP

Add UMAP coordinates to an NG-CHM.

chmAddUWOT

Add UWOT::UMAP coordinates to an NG-CHM.

chmAxis

Create a new Axis for adding to an NG-CHM.

chmAxisType

Create a new AxisType for adding to an ngchmAxis.

chmBindFunction-method

Bind values to an existing JS function.

chmBrowse

Browse the NGCHMs on the specified server in the viewer.

chmColOrder-method

Set the column order of data shown in a NGCHM.

chmColorMap-set

Set the color map of an NG-CHM object

chmColorMap

Get the color map of an NG-CHM object.

chmColors-set

Set the colors of an ngchmColormap, ngchmLayer, ngchmBar, or ngchmCova...

chmColors

Get the colors of an ngchmColormap, ngchmLayer, ngchmBar, or ngchmCova...

chmCovariate

Get a covariate attached to an NG-CHM dataset.

chmCovariateBar

Get a covariate bar attached to an NG-CHM.

chmCreateCollection

Create a new NG-CHM Collection

chmCreateManagedServer

Create an ngchmServer object for a managed NG-CHM server

chmCreateServer

Create an ngchmServer object from a specification.

chmCurrentCollection

Get the user's current collection

chmCurrentServer

Get the user's current server

chmDefaultColOrder

Return default column order of an NGCHM

chmDefaultRowOrder

Return default row order of an NGCHM

chmDeployServer-method

Get the name of a NGCHM server.

chmExportToFile-method

Export a standalone NGCHM to a file.

chmExportToHTML-method

Export a standalone HTML containing the NGCHM to a file.

chmExportToPDF-method

Export a PDF of the NGCHM to a file.

chmFieldAccessFunction

Get Javascript function name for accessing a specific string field in ...

chmGetDataset-method

Get the dataset from an NG-CHM object

chmGetDeployServerConfig

Get per-user configuration for a specific deploy Server.

chmGetFunction

Get a predefined Javascript function for use in NGCHM menus

chmGetOverview

Get the file path to the specified overview file.

chmGetProperty-method

Get Property from NG-CHM

chmGetTypeInfo

Get information about a type name.

chmGetURL-method

Get the URL for an installed NGCHM.

chmHasProperty-method

Determine if the NG-CHM has the given property.

chmInstall-method

Add an NG-CHM to an NG-CHM collection.

chmLabel-set

Set the label/name of an NG-CHM object

chmLabel

Get the label/name of an NG-CHM object.

chmLayer-set

Set (or append) a specified Data Layer in an NG-CHM.

chmLayer

Get a specified Data Layer from an NG-CHM.

chmListFunctions

List the predefined Javascript functions available for use in NGCHM me...

chmListServers

List NG-CHM Servers

chmListTypes

List known axis types.

chmLoadCHM-method

Load CHM from NG-CHM server

chmLoadShaidyCHM

Load an NG-CHM from an NG-CHM server.

chmMake-method

Compile a NGCHM.

chmMakePrivate-method

Make NG-CHM Private on Server

chmMakePublic-method

Make NG-CHM Public on Server

chmManager

Open the NG-CHM Manager

chmName-method

Get the name of a NGCHM.

chmNew

Create a new NGCHM.

chmNewColorMap

Create a new Color Map for use in constructing a NGCHM

chmNewCovariate

Create a new Covariate for adding to an NGCHM auxilary dataset.

chmNewCovariateBar

Create a new covariate Bar for a NGCHM

chmNewDataLayer

Create a new Data Layer for a NGCHM.

chmNewDataset

Create a new Dataset for a NGCHM.

chmNewDialog

Create a new Dialog for a NGCHM.

chmNewFunction

Create a new Javascript function for adding to a NGCHM menu.

chmNewProperty

Create a new Property for adding to a NGCHM.

chmNewServer

Create a new object representing a NGCHM server.

chmOriginalColOrder

Return original column order of an NGCHM

chmOriginalRowOrder

Return original row order of an NGCHM

chmProperties

Create NG-CHM Properties

chmProperty-set

Set the value of an NG-CHM property.

chmProperty

Get the value of an NG-CHM property.

chmRandomColOrder

Return random column order of an NGCHM

chmRandomRowOrder

Return random row order of an NGCHM

chmRegisterAxisFunction

Register a predefined Javascript function for use in NGCHM Axis menus.

chmRegisterFunction

Register a predefined Javascript function for use in NGCHM menus.

chmRegisterGetMetadataFunction

Define and register a Javascript function for obtaining a specific met...

chmRegisterMatrixFunction

Register a predefined Javascript function for use in NGCHM Matrix menu...

chmRegisterToolboxFunction

Register a Javascript function for use in the NGCHM toolbox.

chmRegisterType

Register a type name.

chmRegisterTypeMapper

Register a predefined Javascript function for converting values from o...

chmRegisterTypeSplitter

Define and register a Javascript function for converting a lists of ty...

chmRowOrder-method

Set the row order of data shown in a NGCHM.

chmServer

Get a registered ngchmServer object for use in making and installing N...

chmSetCollection

Set the user's current server and/or collection

chmSetCredentials-method

Set Access Credentials for NG-CHM Server

chmSetDeployServerConfig

Specify per-user configuration for a specific deploy Server.

chmStringopFunction

Get Javascript function name for performing a specific string operatio...

chmTreeGaps

Creates new treeCuts object

chmUninstall-method

Remove an NG-CHM from Server

chmUrlBase-method

Get the base URL for a NGCHM installed on a NGCHM server.

chmWriteCustomJS

Output Javascript code required to customize an NGCHM.

getDimensions-method

Generic method to get a dimensions matrix from obj.

gitHashObject

Obtain the git hash of an existing file.

initLogging

Initialize Logging

ngchm-class

Class representing a Next Generation Clustered Heat Map (NGCHM) under ...

NGCHM-functions

Javascript extensions for the Next Generation Clustered Heat Map (NGCH...

NGCHM-initialization

Initialization of the NGCHM library.

NGCHM-package

Next Generation Clustered Heat Map (NGCHM) Construction Library

ngchmAddDatasetBlob

Add a data file to a local shaidy repository

ngchmAddMatrixToCollection

Add a matrix reference to a collection

ngchmAddObjectToCollection

Add an object reference to a collection

ngchmAxis-class

Class representing an axis of a Next Generation Clustered Heat Map (NG...

ngchmAxisFunction-class

Class representing an axis function for Next Generation Clustered Heat...

ngchmAxisType-class

Class representing a type attached to an axis in a Next Generation Clu...

ngchmBar-class

Class representing a Covariate Bar on a Next Generation Clustered Heat...

ngchmCollectionInCollection

Recursively determine if collection uuid is contained in collection A ...

ngchmCollectionTree

Create a recursive description of a collection

ngchmColormap-class

Class representing a Color Map on a Next Generation Clustered Heat Map...

ngchmCovariate-class

Class representing a Covariate attached to a Dataset

ngchmCreateServerProtocol

Create and register an NGCHM server protocol implementation.

ngchmCSS-class

Class representing custom CSS for a Next Generation Clustered Heat Map...

ngchmDataset-class

Class representing a Dataset attached to a NGCHM

ngchmDialog-class

Class representing an addon dialog

ngchmFindRepo

Find a repository, if any, that contains the requested shaid

ngchmGetDataFileShaid

Compute shaid for a data file

ngchmGetEnv

Get the ngchm environment (for debugging only).

ngchmGetHandleHTTR

Get a HTTR handle for the server's view/WS URL

ngchmGetLabels

Get the axis labels of a shaidy dataset or dendrogram

ngchmGetLabelsStr

Get the axis labels of a shaidy dataset or dendrogram

ngchmGetProtoParam

Get Protocol Parameter for NG-CHM Server

ngchmGetServerProtocol

Get Server Protocol for NG-CHM

ngchmInitShaidyRepository

Initialize Shaidy Repository for NG-CHM

ngchmJS-class

Class representing a custom Javascript function for a Next Generation ...

ngchmLayer-class

Class representing a Layer on a Next Generation Clustered Heat Map (NG...

ngchmListServerProtocols

List defined server protocols

ngchmLoadDatasetBlob

Load a data matrix from a local shaidy repository

ngchmMakeFormat.original

Make an original format NGCHM.

ngchmMakeFormat.shaidy

Make a shaidy format NGCHM.

ngchmMatrixFunction-class

Class representing a matrix function for Next Generation Clustered Hea...

ngchmMenuItem-class

Class representing a Menu Item for a Next Generation Clustered Heat Ma...

ngchmMetaData-class

Class representing meta data attached to an NG-CHM

ngchmNewBar

Create a new Classification Bar for a NGCHM

ngchmNewCollection

Create a new collection in a local shaidy repository

ngchmOverview-class

Class representing an overview of a Next Generation Clustered Heat Map...

ngchmProperty-class

Class representing a Generic Property for a Next Generation Clustered ...

ngchmProtoParamCheck

Check Protocol Parameters for NG-CHM

ngchmPushSourceRepository

Push a local shaidy repository onto the stack of source repositories

ngchmPushSourceServer

Push a shaidy server onto the stack of source repositories

ngchmPushTempRepository

Push Temporary Repository for NG-CHM

ngchmRegisterServer

Register an ngchmServer.

ngchmRelated-class

Class representing a link related to a NGCHM

ngchmRelatedGroup-class

Class representing a group of related links to a NGCHM

ngchmRenderChm

Render a shaidy NGCHM

ngchmResponseJSON

Return response content interpreted as JSON

ngchmRowCenter

Row center a shaidy dataset

ngchmSaveAsDatasetBlob

Save a numeric matrix as a blob in a shaidy repository

ngchmSaveAsDendrogramBlob

Save a dendrogram as a blob in a shaidy repository

ngchmSaveChmAsBlob

Save an NGCHM as a shaidy blob

ngchmServer-class

Class representing a Next Generation Clustered Heat Map (NGCHM) server...

ngchmServerProtocol-class

Class representing a deployment method for a Next Generation Clustered...

ngchmTemplate-class

Class representing a Template attached to a NGCHM

ngchmTileDataset

Get the tiles for a shaidy dataset

ngchmTypeMapper-class

Class representing a type mapper function for Next Generation Clustere...

ngchmUnregisterServer

Unregister NG-CHM Server

ngchmValueProp-class

Class representing the properties of a data point in a Next Generation...

ngchmVersion2-class

Class representing ngchmVersion2 object

optDendrogram-class

Optional Dendrogram

plot.ngchmVersion2

Open the NG-CHM on the specified server in the viewer.

print.ngchm.type.info

Pretty Print NGCHM Type Information

print.shaidyRepo

Print a shaidy repository

shaid-class

Class representing the shaid of an object

shaidyAddFileBlob

Add data file(s) and properties to a local shaidy repository

shaidyBlobExists

Determine if one more blobs exist in a shaidy repository

shaidyCopyBlob

Copy a blob from one repository to another

shaidyCreateProtoBlob

Create a prototype blob in a shaidy repository

shaidyFinalizeProtoBlob

Finalize a prototype blob

shaidyFindRepo

Find the first repository, if any, that contains the requested shaid

shaidyGetComponents-method

Get an object's component shaids

shaidyGetShaid-method

Get shaid for an object

shaidyHashProtoBlob

Compute the shaid to assign a protoblob

shaidyInitRepository

Create and initialize Shaidy Repository

shaidyLoadProvenanceDB

Load the provid -> shaid DB for a local shaidy repository

shaidyLoadProvidDB

Load the provid -> labels DB for a local shaidy repository.

shaidyLoadRepository

Load a shaidy repository

shaidyNewCache

Create in memory shaid cache

shaidyProvenance

Create a provid from a list of label values

shaidyRepoAPI

Get the methods for the repository API called api

treeCuts-class

Helper class for setting row/col gap locations as tree cuts

verifyNumeric

Helper function to verify if variable is numeric.

Next-Generation Clustered Heat Maps (NG-CHMs) allow for dynamic exploration of heat map data in a web browser. 'NGCHM' allows users to create both stand-alone HTML files containing a Next-Generation Clustered Heat Map, and .ngchm files to view in the NG-CHM viewer. See Ryan MC, Stucky M, et al (2020) <doi:10.12688/f1000research.20590.2> for more details.

  • Maintainer: Mary A Rohrdanz
  • License: GPL-3
  • Last published: 2024-12-17