higlass/dist/app/scripts/utils/get-aggregation-function.d.ts

HiGlass Hi-C / genomic / large data viewer

export default getAggregationFunction;
export type Aggregation = (values: number[]) => number | undefined;
/** @typedef {(values: number[]) => number | undefined} Aggregation */
/**
 * Get an aggregation function from a function name.
 * @param {'mean' | 'sum' | 'variance' | 'deviation'} name - The type of aggregation.
 * If an unknown string is passed, the mean function will be used (and a warning will be logged).
 * @returns {Aggregation} The function of interest as determined by the string,
 */
declare function getAggregationFunction(name: "mean" | "sum" | "variance" | "deviation"): Aggregation;