Skip to content

Commit 0a48e9c

Browse files
author
Benedikt Obermayer
committed
fix README
1 parent 4137afd commit 0a48e9c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,16 @@ and then point your browser to http://0.0.0.0:8050/.
7171
Preparing Your Data
7272
-------------------
7373

74-
Data sets are provided as HDF5 files (`anndata <https://anndata.readthedocs.io/en/latest/index.html>`_ objects) that store gene expression (sparse CSR matrix) and meta data with very fast read access.
74+
Data sets are provided as HDF5 files (`anndata <https://anndata.readthedocs.io/en/latest/index.html>`__ objects) that store gene expression (sparse CSR matrix) and meta data with very fast read access.
7575

7676
For the input you can either specify one HDF5 file or a directory containing multiple such files.
7777

78-
You can use `scanpy <http://scanpy.rtfd.io>`_ to create this HDF5 file directly or use the ``scelvis convert`` command for converting your single-cell pipeline output.
78+
You can use `scanpy <http://scanpy.rtfd.io>`__ to create this HDF5 file directly or use the ``scelvis convert`` command for converting your single-cell pipeline output.
7979

8080
HDF5 Input
8181
----------
8282

83-
for HDF5 input, you can do your analysis with `scanpy <http://scanpy.rtfd.io>`_ to create an anndata object ``ad``. SCelVis will use embedding coordinates from ``ad.obsm``, cell annotation from ``ad.obs`` and expression data directly from ``ad.X`` (this should contain normalized and log-transformed expression values for all genes). If present, information about the dataset will be extracted from strings stored in ``ad.uns['about_title']``, ``ad.uns['about_short_title']`` and ``ad.uns['about_readme']`` (assumed to be Markdown). Information about marker genes will be taken either from the ``rank_genes_groups`` slot in ``ad.uns`` or from entries starting with ``marker_`` in ``ad.uns``: entries called ``marker_gene`` (required!), ``marker_cluster``, ``marker_padj``, ``marker_LFC`` will create a table with the columns ``gene``, ``cluster``, ``padj``, and ``LFC``.
83+
for HDF5 input, you can do your analysis with `scanpy <http://scanpy.rtfd.io>`__ to create an anndata object ``ad``. SCelVis will use embedding coordinates from ``ad.obsm``, cell annotation from ``ad.obs`` and expression data directly from ``ad.X`` (this should contain normalized and log-transformed expression values for all genes). If present, information about the dataset will be extracted from strings stored in ``ad.uns['about_title']``, ``ad.uns['about_short_title']`` and ``ad.uns['about_readme']`` (assumed to be Markdown). Information about marker genes will be taken either from the ``rank_genes_groups`` slot in ``ad.uns`` or from entries starting with ``marker_`` in ``ad.uns``: entries called ``marker_gene`` (required!), ``marker_cluster``, ``marker_padj``, ``marker_LFC`` will create a table with the columns ``gene``, ``cluster``, ``padj``, and ``LFC``.
8484

8585
If you prepared your data with ``Seurat`` (v2), you can use ``Convert(from = sobj, to = "anndata", filename = "data.h5ad")`` to get an HDF5 file.
8686

@@ -134,7 +134,7 @@ in ``examples/dummy_raw.zip`` and ``examples/dummy_about.md`` we provide raw dat
134134
Loom Input
135135
----------
136136

137-
for `loompy <http://loompy.org>`_ or `loomR <https://github.com/mojaveazure/loomR>`_ input, you can convert your data like this:
137+
for `loompy <http://loompy.org>`__ or `loomR <https://github.com/mojaveazure/loomR>`__ input, you can convert your data like this:
138138

139139
.. code-block:: shell
140140
@@ -192,7 +192,7 @@ Data sources can be:
192192
193193
- paths, e.g., ``relative/paths`` or ``/absolute/paths`` or ``file://url/paths``
194194
- SFTP URLs, e.g., ``sftp://user:password@host/path/to/data``
195-
- FTP URLs, e.g., ``ftp://user:password@host/path/to/data`` (sadly encryption is not supported by the underlying library `PyFilesystem2 <https://github.com/PyFilesystem/pyfilesystem2>`_.
195+
- FTP URLs, e.g., ``ftp://user:password@host/path/to/data`` (sadly encryption is not supported by the underlying library `PyFilesystem2 <https://github.com/PyFilesystem/pyfilesystem2>`__.
196196
- iRODS URLS, e.g., ``irods://user:password@host/zoneName/path/to/data``
197197
- Enable SSL via ``irods+ssl``
198198
- Switch to PAM authentication with ``irods+pam`` (you can combine this with ``+ssl`` in any order)
@@ -230,7 +230,7 @@ The prerequisites are:
230230
231231
- Python 3, either
232232
- system-wide installation with ``virtualenv``, or
233-
- installed with `Conda <https://docs.conda.io/en/latest/>`_.
233+
- installed with `Conda <https://docs.conda.io/en/latest/>`__.
234234
235235
For ``virtualenv``, first create a virtual environment and activate it.
236236
@@ -265,13 +265,13 @@ Afterwards, you can run the visualization web server as follows:
265265
Releasing Packages
266266
------------------
267267
268-
For the `PyPi package <https://pypi.org/project/scelvis/>`_:
268+
For the `PyPi package <https://pypi.org/project/scelvis/>`__:
269269
270270
.. code-block:: shell
271271
272272
$ python setup.py sdist
273273
$ twine upload --repository-url https://test.pypi.org/legacy/ dist/scelvis-*.tar.gz
274274
$ twine upload dist/scelvis-*.tar.gz
275275
276-
For the Bioconda package, see `the great documentation <http://bioconda.github.io/updating.html>`_.
276+
For the Bioconda package, see `the great documentation <http://bioconda.github.io/updating.html>`__.
277277
The Docker image will automatically be created as a BioContainer when the Bioconda package is built.

0 commit comments

Comments
 (0)