Skip to content

Commit

Permalink
Small changes in README restructured text syntax. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
bramvds committed May 2, 2018
1 parent 9355fc0 commit 3636761
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
1 change: 0 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ The lastest stable release of the **package** itself can be installed via :code:


.. caution::

pySCENIC needs a python 3.5 or greater interpreter.


Expand Down
9 changes: 4 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

pySCENIC
========

Expand All @@ -20,7 +19,7 @@ The pipeline has three steps:
3. Finally, the original cells are differentiated and clustered on the activity of these discovered regulons.

.. note::
The most impactfull speed improvement is introduced by the arboretum_ package in step 1. This package provides an alternative to GENIE3 [3]_ called GRNBoost2. This package can be controlled from within pySCENIC.
The most impactfull speed improvement is introduced by the arboretum_ package in step 1. This package provides an alternative to GENIE3 [3]_ called GRNBoost2. This package can be controlled from within pySCENIC.

.. sidebar:: **Quick Start**

Expand All @@ -46,7 +45,7 @@ Installation
The lastest stable release of the **package** itself can be installed via :code:`pip install pyscenic`.

.. caution::
pySCENIC needs a python 3.5 or greater interpreter.
pySCENIC needs a python 3.5 or greater interpreter.

You can also install the bleeding edge (i.e. less stable) version of the package directly from the source:

Expand Down Expand Up @@ -122,7 +121,7 @@ dm6-5kb-upstream-full-tx_ Drosophila melanogaster [TSS+5kb,full Tx
.. _`Flybase annotations`: http://pyscenic.aertslab.org/resources/motifs-v8-nr.flybase-m0.001-o0.0.tbl

.. caution::
These ranking databases are 1.1 Gb each so downloading them might take a while. An annotations file is typically 100Mb in size.
These ranking databases are 1.1 Gb each so downloading them might take a while. An annotations file is typically 100Mb in size.

Tutorial
--------
Expand Down Expand Up @@ -230,7 +229,7 @@ The first method to create the TF-modules is to select the best targets for each

1. Targets with importance > the 50th percentile.
2. Targets with importance > the 75th percentile
2. Targets with importance > the 90th percentile.
3. Targets with importance > the 90th percentile.

The second method is to select the top targets for a given TF:

Expand Down

0 comments on commit 3636761

Please sign in to comment.