Skip to content

Commit

Permalink
Version 1.0.0:
Browse files Browse the repository at this point in the history
Updated reference.
  • Loading branch information
lingfeiwang committed Nov 4, 2021
1 parent 36fdcf0 commit dac3b0e
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 20 deletions.
12 changes: 6 additions & 6 deletions PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Metadata-Version: 2.1
Name: normalisr
Version: 0.6.1
Version: 1.0.0
Summary: Normalisr Offers Robust Modelling of Associations Linearly In Single-cell RNA-seq
Home-page: https://github.com/lingfeiwang/normalisr
Author: Lingfei Wang
Author-email: [email protected]
License: BSD-3-Clause
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: BSD License
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Expand All @@ -32,13 +32,13 @@ Normalisr is a parameter-free normalization and statistical association testing

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.

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_).
Normalisr is in python and provides a command-line and a python functional interface. Normalisr is published in `Nature Communications <https://doi.org/10.1038/s41467-021-26682-1>`_ (2021).

Installation
=============
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.

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_).
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 Issues_).

Usage
=====
Expand Down Expand Up @@ -70,13 +70,13 @@ You can find several examples in the 'examples' folder, to cover all functions N

You can find more details in the respective examples.

Contact
Issues
==========================
Pease raise an issue on `github <https://github.com/lingfeiwang/normalisr/issues/new>`_.

References
==========================
* 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
* Single-cell normalization and association testing unifying CRISPR screen and gene co-expression analyses with Normalisr, Lingfei Wang, Nature Communications 2021. https://doi.org/10.1038/s41467-021-26682-1

FAQ
==========================
Expand Down
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Normalisr is a parameter-free normalization and statistical association testing

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.

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_).
Normalisr is in python and provides a command-line and a python functional interface. Normalisr is published in `Nature Communications <https://doi.org/10.1038/s41467-021-26682-1>`_ (2021).

Installation
=============
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.

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_).
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 Issues_).

Usage
=====
Expand Down Expand Up @@ -50,13 +50,13 @@ You can find several examples in the 'examples' folder, to cover all functions N

You can find more details in the respective examples.

Contact
Issues
==========================
Pease raise an issue on `github <https://github.com/lingfeiwang/normalisr/issues/new>`_.

References
==========================
* 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
* Single-cell normalization and association testing unifying CRISPR screen and gene co-expression analyses with Normalisr, Lingfei Wang, Nature Communications 2021. https://doi.org/10.1038/s41467-021-26682-1

FAQ
==========================
Expand Down
3 changes: 3 additions & 0 deletions UPDATES
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
1.0.0:
Updated reference.

0.6.1:
Bug correction for parameter single in normalisr.de.de not being passed through correctly.
Updated documentation.
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h1>Welcome to Normalisr’s documentation!<a class="headerlink" href="#welcome-
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#examples-and-pipelines">Examples and pipelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#contact">Contact</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#issues">Issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#references">References</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#faq">FAQ</a></li>
</ul>
Expand Down
12 changes: 6 additions & 6 deletions docs/build/html/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ <h1>Normalisr<a class="headerlink" href="#normalisr" title="Permalink to this he
<a class="reference external image-reference" href="https://zenodo.org/badge/latestdoi/242889849"><img alt="https://zenodo.org/badge/242889849.svg" src="https://zenodo.org/badge/242889849.svg" /></a>
<p>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.</p>
<p>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 (<em>e.g.</em> batches, house-keeping programs, and untested gRNAs) as fixed effects, (iii) robustness against read count distribution distortions with enough (&gt; 100) cells, and (iv) computational efficiency.</p>
<p>Normalisr is in python and provides a command-line and a python functional interface. You can read more about Normalisr from our preprint (See <a class="reference internal" href="#references">References</a>).</p>
<p>Normalisr is in python and provides a command-line and a python functional interface. Normalisr is published in <a class="reference external" href="https://doi.org/10.1038/s41467-021-26682-1">Nature Communications</a> (2021).</p>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>Normalisr is on <a class="reference external" href="https://pypi.org/project/normalisr">PyPI</a> and can be installed with pip: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">normalisr</span></code>. You can also install Normalisr from github: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">git+https://github.com/lingfeiwang/normalisr.git</span></code>. Make sure you have added Normalisr’s install path into PATH environment before using the command-line interface (See <a class="reference internal" href="#faq">FAQ</a>). Normalisr’s installation should take less than a minute.</p>
<p>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 <a class="reference internal" href="#contact">Contact</a>).</p>
<p>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 <a class="reference internal" href="#issues">Issues</a>).</p>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -76,14 +76,14 @@ <h2>Examples and pipelines<a class="headerlink" href="#examples-and-pipelines" t
<p>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.</p>
<p>You can find more details in the respective examples.</p>
</div>
<div class="section" id="contact">
<h2>Contact<a class="headerlink" href="#contact" title="Permalink to this headline"></a></h2>
<div class="section" id="issues">
<h2>Issues<a class="headerlink" href="#issues" title="Permalink to this headline"></a></h2>
<p>Pease raise an issue on <a class="reference external" href="https://github.com/lingfeiwang/normalisr/issues/new">github</a>.</p>
</div>
<div class="section" id="references">
<h2>References<a class="headerlink" href="#references" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Normalisr: normalization and association testing for single-cell CRISPR screen and co-expression, Lingfei Wang, preprint 2021. <a class="reference external" href="https://www.biorxiv.org/content/10.1101/2021.04.12.439500v1">https://www.biorxiv.org/content/10.1101/2021.04.12.439500v1</a></p></li>
<li><p>Single-cell normalization and association testing unifying CRISPR screen and gene co-expression analyses with Normalisr, Lingfei Wang, Nature Communications 2021. <a class="reference external" href="https://doi.org/10.1038/s41467-021-26682-1">https://doi.org/10.1038/s41467-021-26682-1</a></p></li>
</ul>
</div>
<div class="section" id="faq">
Expand Down Expand Up @@ -142,7 +142,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples-and-pipelines">Examples and pipelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contact">Contact</a></li>
<li class="toctree-l2"><a class="reference internal" href="#issues">Issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="#references">References</a></li>
<li class="toctree-l2"><a class="reference internal" href="#faq">FAQ</a></li>
</ul>
Expand Down
Loading

0 comments on commit dac3b0e

Please sign in to comment.