xlmhg 2.2.8

XL-mHG: A Semiparametric Test for Enrichment

master
develop

This is an efficient Python/Cython implementation of the semiparametric XL-mHG test for enrichment in ranked lists. The XL-mHG test is an extension of the nonparametric mHG test, which was developed by Dr. Zohar Yakhini and colleagues.

If you use the XL-mHG test in your research, please cite Eden et al. (PLoS Comput Biol, 2007) and Wagner (PLoS One, 2015).

Installation

$ pip install xlmhg

Usage

import xlmhg
stat, cutoff, pval = xlmhg.xlmhg_test(v, X, L)

Where: v is the ranked list of 0’s and 1’s, represented by a NumPy array of type "np.uint8", X` and L are parameters, and the return values have the following meanings:

• stat: The XL-mHG test statistic

• cutoff: The cutoff at which the XL-mHG test statistic was attained

• pval: The XL-mHG p-value

What do the X and L parameters mean?

• X refers to the minimum number of “1’s” that have to be seen before anything can be called “enrichment”.

• L is the lowest cutoff (i.e., the largest n) that is being tested for enrichment.

A more direct way to understand X and L is through the definition of the XL-mHG test statistic. It is defined as the minimum hypergeometric p-value over all cutoffs at which at least X “1’s” have already been seen, and excluding any cutoffs larger than L. For X=1 and L=N, the XL-mHG test reduces to the mHG test.

Background

For a discussion of the statistical background and implementation of this test, please see the Technical Report on arXiv, as well as the XL-mHG PeerJ Preprint article.

Copyright and License

Copyright (c) 2015, 2016 Florian Wagner

XL-mHG is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License, Version 3,
as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.