generate2dJsDivergenceDataFrame: Jensen-Shannon divergence between multiple two-dimensional...

View source: R/js_divergence.R

generate2dJsDivergenceDataFrameR Documentation

Jensen-Shannon divergence between multiple two-dimensional maps.

Description

Calculate the Jensen-Shannon (JS) divergence between two or more two-dimensional maps and generate a data frame displaying the divergence value for each possible pair of two-dimensional maps. The two-dimensional maps are generated from the source files and columns of interest (two_d_map_column_names). The maps may be generated by a dimensionality reduction (DR) method; however this is not a requirement.

Usage

generate2dJsDivergenceDataFrame(source_filepaths,
  two_d_map_column_names = c("tSNE1", "tSNE2"), n = 2^8)

Arguments

source_filepaths

A vector containing the file paths for the data of interest.

two_d_map_column_names

A vector containing the column names of interest. Defaults to Cytobank's default tSNE column names.

n

Number of grid points for KDE.

Value

A data frame that includes a numeric for the JS divergence between each possible combination of generated 2-D maps.

See Also

calculateJsDivergence


dtelad11/cytutils documentation built on Sept. 1, 2022, 2:45 p.m.