You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Normalisr is a parameter-free normalization-association two-step inferential framework for scRNA-seq that solves case-control differential expression, co-expression, and pooled CRISPR scRNA-seq screen analysis with linear association testing. By systematically detecting and removing nonlinear confounding from library size, Normalisr achieves high sensitivity, specificity, speed, and generalizability across multiple scRNA-seq protocols and experimental conditions with unbiased P-value estimation.
20
-
21
-
Normalisr first removes confounding technical noises from raw read counts to recover the biological variations. Then, linear association testing provides a unified inferential framework with several advantages: (i) exact P-value estimation without permutation, (ii) native removal of covariates (*e.g.* batches, house-keeping programs, and untested gRNAs) as fixed effects, and (iii) computational efficiency.
22
-
23
-
Normalisr is written in Python3 and provides a command-line and a python functional interface. You can read more about Normalisr from our preprint (See References_).
24
-
25
-
Installation
26
-
=============
27
-
Normalisr is on `PyPI <https://pypi.org/project/normalisr>`_ and can be installed with pip: ``pip install normalisr``. You can also install Normalisr from github: ``pip install git+https://github.com/lingfeiwang/normalisr.git``. Make sure you have added Normalisr's install path into PATH environment before using the command-line interface (See FAQ_). Normalisr's installation should take less than a minute.
28
-
29
-
There are more advanced installation methods but if you want that, most likely you already know how to do it. If not, give me a shout (See Contact_).
30
-
31
-
Usage
32
-
=====
33
-
Normalisr provides a command-line and a python functional interface below. You can use the examples provided below to guide yourself through Normalisr's use. Sphinx-based documentation is underway.
34
-
35
-
* Commmand-line interface
36
-
You can run Normalisr by typing ``normalisr`` on command-line. Normalisr uses submodules for different analysis steps. Type ``normalisr`` or ``normalisr -h`` for general help, and for example ``normalisr de -h`` for help on submodule 'de' of differential expression.
37
-
38
-
Normalisr uses tsv (tab separated values) file format for input and output matrices, and text file for row and column names, such as cells and genes, one per line. For initial input, Normalisr also accepts the sparse mtx format (Cell Ranger output) for raw read count matrix. Gzipped input/output files are automatically recognized if file name suffix '.gz' is present.
39
-
40
-
* Python functional interface
41
-
Normalisr's python functional interface is more flexible than command-line, but requires knowledge of python programming. Documentation of any function can be obtained with ``?`` in ipython or jupyter notebook, such as:
42
-
43
-
.. code-block::
44
-
45
-
import normalisr.normalisr as norm
46
-
?norm.de
47
-
48
-
The example jupyter notebooks also illustrate the scope of functions Normalisr provides.
49
-
50
-
51
-
Documentation
52
-
=============
53
-
Documentations are available as `html <https://lingfeiwang.github.io/normalisr/index.html>`_ and `pdf <https://github.com/lingfeiwang/normalisr/raw/master/docs/build/latex/normalisr.pdf>`_.
54
-
55
-
Examples and pipelines
56
-
==========================
57
-
You can find several examples in the 'examples' folder, to cover all functions Normalisr currently provides. The example datasets have been scaled down to run on a 16GB-memory personal computer. Although they only serve as demonstrations of work here, the pipelines should be transferable to a full-scale, different dataset. Since Normalisr is non-parametric, the only adjustable parameters are for quality control and final cutoffs of differential or co-expression. You can change down-sampling parameters in the examples to run the full datasets on a larger computer.
58
-
59
-
You can find more details in the respective examples.
60
-
61
-
Contact
62
-
==========================
63
-
Pease raise an issue on `github <https://github.com/lingfeiwang/normalisr/issues/new>`_ or reach me by e-mail (Lingfei.Wang.github@outlook.com or contact on the manuscript).
64
-
65
-
References
66
-
==========================
67
-
* Normalisr: normalization and association testing for single-cell CRISPR screen and co-expression, Lingfei Wang, preprint 2021. https://www.biorxiv.org/content/10.1101/2021.04.12.439500v1
68
-
69
-
FAQ
70
-
==========================
71
-
* What does Normalisr stand for?
72
-
**N**\ ormalisr **O**\ ffers **R**\ obust **M**\ odelling of **A**\ ssociations **L**\ inearly **I**\ n **S**\ ingle-cell **R**\ NA-seq. Yes, it's a recursive acronym. See `GNU <https://www.gnu.org/gnu/gnu-history.en.html>`_ and `pip <http://www.ianbicking.org/blog/2008/10/28/pyinstall-is-dead-long-live-pip/index.html>`_.
73
-
74
-
* I installed Normalisr but typing ``normalisr`` says 'command not found'.
75
-
See below.
76
-
77
-
* How do I use a specific python version for Normalisr's command-line interface?
78
-
You can always use the python command to run Normalisr, such as ``python3 -m normalisr`` to replace command ``normalisr``. You can also use a specific path or version for python, such as ``python3.7 -m normalisr`` or ``/usr/bin/python3.7 -m normalisr``. Make sure you have installed Normalisr for this python version.
79
-
80
-
81
-
* Why don't the examples work?
82
-
Please make sure you followed every step in the README.md of the respective example folder with Internet connection, and then submit an issue report detailing at which executed line the error occurred with input and output.
83
-
84
-
85
-
* Does Normalisr run on Windows?
86
-
I have not tested Normalisr on Windows. However, it is purely in python and should be able to function properly.
87
-
88
9
Platform: UNKNOWN
89
10
Classifier: Development Status :: 4 - Beta
90
11
Classifier: License :: OSI Approved :: BSD License
@@ -95,3 +16,85 @@ Classifier: Operating System :: OS Independent
Normalisr is a parameter-free normalization and statistical association testing framework that unifies single-cell differential expression, co-expression, and pooled single-cell CRISPR screen analyses with linear models. By systematically detecting and removing nonlinear confounders arising from library size at mean and variance levels, Normalisr achieves high sensitivity, specificity, speed, and generalizability across multiple scRNA-seq protocols and experimental conditions with unbiased p-value estimation.
32
+
33
+
Normalisr first removes confounding technical noises from raw read counts to recover the biological variations. Then, linear association testing provides a unified inferential framework with several advantages: (i) exact P-value estimation without permutation, (ii) native removal of covariates (*e.g.* batches, house-keeping programs, and untested gRNAs) as fixed effects, (iii) robustness against read count distribution distortions with enough (> 100) cells, and (iv) computational efficiency.
34
+
35
+
Normalisr is in python and provides a command-line and a python functional interface. You can read more about Normalisr from our preprint (See References_).
36
+
37
+
Installation
38
+
=============
39
+
Normalisr is on `PyPI <https://pypi.org/project/normalisr>`_ and can be installed with pip: ``pip install normalisr``. You can also install Normalisr from github: ``pip install git+https://github.com/lingfeiwang/normalisr.git``. Make sure you have added Normalisr's install path into PATH environment before using the command-line interface (See FAQ_). Normalisr's installation should take less than a minute.
40
+
41
+
There are more advanced installation methods but if you want that, most likely you already know how to do it. If not, give me a shout (See Contact_).
42
+
43
+
Usage
44
+
=====
45
+
Normalisr provides a command-line and a python functional interface below. You can use the examples provided below to guide yourself through Normalisr's use. Sphinx-based documentation is underway.
46
+
47
+
* Commmand-line interface
48
+
You can run Normalisr by typing ``normalisr`` on command-line. Normalisr uses submodules for different analysis steps. Type ``normalisr`` or ``normalisr -h`` for general help, and for example ``normalisr de -h`` for help on submodule 'de' of differential expression.
49
+
50
+
Normalisr uses tsv (tab separated values) file format for input and output matrices, and text file for row and column names, such as cells and genes, one per line. For initial input, Normalisr also accepts the sparse mtx format (Cell Ranger output) for raw read count matrix. Gzipped input/output files are automatically recognized if file name suffix '.gz' is present.
51
+
52
+
* Python functional interface
53
+
Normalisr's python functional interface is more flexible than command-line, but requires knowledge of python programming. Documentation of any function can be obtained with ``?`` in ipython or jupyter notebook, such as:
54
+
55
+
.. code-block::
56
+
57
+
import normalisr.normalisr as norm
58
+
?norm.de
59
+
60
+
The example jupyter notebooks also illustrate the scope of functions Normalisr provides.
61
+
62
+
63
+
Documentation
64
+
=============
65
+
Documentations are available as `html <https://lingfeiwang.github.io/normalisr/index.html>`_ and `pdf <https://github.com/lingfeiwang/normalisr/raw/master/docs/build/latex/normalisr.pdf>`_.
66
+
67
+
Examples and pipelines
68
+
==========================
69
+
You can find several examples in the 'examples' folder, to cover all functions Normalisr currently provides. The example datasets have been scaled down to run on a 16GB-memory personal computer. Although they only serve as demonstrations of work here, the pipelines should be transferable to a full-scale, different dataset. Since Normalisr is non-parametric, the only adjustable parameters are for quality control and final cutoffs of differential or co-expression. You can change down-sampling parameters in the examples to run the full datasets on a larger computer.
70
+
71
+
You can find more details in the respective examples.
72
+
73
+
Contact
74
+
==========================
75
+
Pease raise an issue on `github <https://github.com/lingfeiwang/normalisr/issues/new>`_.
76
+
77
+
References
78
+
==========================
79
+
* Normalisr: normalization and association testing for single-cell CRISPR screen and co-expression, Lingfei Wang, preprint 2021. https://www.biorxiv.org/content/10.1101/2021.04.12.439500v1
80
+
81
+
FAQ
82
+
==========================
83
+
* What does Normalisr stand for?
84
+
**N**\ ormalisr **O**\ ffers **R**\ obust **M**\ odelling of **A**\ ssociations **L**\ inearly **I**\ n **S**\ ingle-cell **R**\ NA-seq. Yes, it's a recursive acronym. See `GNU <https://www.gnu.org/gnu/gnu-history.en.html>`_ and `pip <http://www.ianbicking.org/blog/2008/10/28/pyinstall-is-dead-long-live-pip/index.html>`_.
85
+
86
+
* I installed Normalisr but typing ``normalisr`` says 'command not found'.
87
+
See below.
88
+
89
+
* How do I use a specific python version for Normalisr's command-line interface?
90
+
You can always use the python command to run Normalisr, such as ``python3 -m normalisr`` to replace command ``normalisr``. You can also use a specific path or version for python, such as ``python3.7 -m normalisr`` or ``/usr/bin/python3.7 -m normalisr``. Make sure you have installed Normalisr for this python version.
91
+
92
+
93
+
* Why don't the examples work?
94
+
Please make sure you followed every step in the README.md of the respective example folder with Internet connection, and then submit an issue report detailing at which executed line the error occurred with input and output.
95
+
96
+
97
+
* Does Normalisr run on Windows?
98
+
I have not tested Normalisr on Windows. However, it is purely in python and should be able to function properly.
Normalisr is a parameter-free normalization-association two-step inferential framework for scRNA-seq that solves case-control differential expression, co-expression, and pooled CRISPR scRNA-seq screen analysis with linear association testing. By systematically detecting and removing nonlinear confounding from library size, Normalisr achieves high sensitivity, specificity, speed, and generalizability across multiple scRNA-seq protocols and experimental conditions with unbiased P-value estimation.
11
+
Normalisr is a parameter-free normalization and statistical association testing framework that unifies single-cell differential expression, co-expression, and pooled single-cell CRISPR screen analyses with linear models. By systematically detecting and removing nonlinear confounders arising from library size at mean and variance levels, Normalisr achieves high sensitivity, specificity, speed, and generalizability across multiple scRNA-seq protocols and experimental conditions with unbiased p-value estimation.
12
12
13
-
Normalisr first removes confounding technical noises from raw read counts to recover the biological variations. Then, linear association testing provides a unified inferential framework with several advantages: (i) exact P-value estimation without permutation, (ii) native removal of covariates (*e.g.* batches, house-keeping programs, and untested gRNAs) as fixed effects, and (iii) computational efficiency.
13
+
Normalisr first removes confounding technical noises from raw read counts to recover the biological variations. Then, linear association testing provides a unified inferential framework with several advantages: (i) exact P-value estimation without permutation, (ii) native removal of covariates (*e.g.* batches, house-keeping programs, and untested gRNAs) as fixed effects, (iii) robustness against read count distribution distortions with enough (> 100) cells, and (iv) computational efficiency.
14
14
15
-
Normalisr is written in Python3 and provides a command-line and a python functional interface. You can read more about Normalisr from our preprint (See References_).
15
+
Normalisr is in python and provides a command-line and a python functional interface. You can read more about Normalisr from our preprint (See References_).
16
16
17
17
Installation
18
18
=============
@@ -52,7 +52,7 @@ You can find more details in the respective examples.
52
52
53
53
Contact
54
54
==========================
55
-
Pease raise an issue on `github <https://github.com/lingfeiwang/normalisr/issues/new>`_ or reach me by e-mail (Lingfei.Wang.github@outlook.com or contact on the manuscript).
55
+
Pease raise an issue on `github <https://github.com/lingfeiwang/normalisr/issues/new>`_.
Copy file name to clipboardExpand all lines: UPDATES
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,8 @@
1
+
0.6.1:
2
+
Bug correction for parameter single in normalisr.de.de not being passed through correctly.
3
+
Updated documentation.
4
+
Compatibility updates.
5
+
1
6
0.6.0:
2
7
Added new association test normalisr.association.association_test_5 that uses given mask to determine X-Y pairs in hypothesis tests with multi-variate regression. This option is not yet available on command line.
3
8
Refactored normalisr.association, normalisr.de, and normalisr.coex.
0 commit comments