Skip to content

Commit

Permalink
docs: update index, restructure API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
balajtimate committed Nov 15, 2024
1 parent 21f72f0 commit 3971d5e
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 23 deletions.
9 changes: 9 additions & 0 deletions docs/guides/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,13 @@ Here is a sample output for the paired-ended library:
}
}
Results
-------

For more details on the output structure, refer to the :code:`Results` model in the API documentation.

- :code:`library_stats`: Read length statistics results, including the minimum, maximum, mean, median and mode.
- :code:`library_source`: Library source inference results, with the short name and NCBI taxonomy ID of the source organism.
- :code:`library_type`: Library type inference results, single- or paired-end. In case of paired-end samples, the mate designation.
- :code:`read_orientation`: Read orientation inference results, based on the fragment library types notation from `Salmon <https://salmon.readthedocs.io/en/latest/library_type.html>`_.
- :code:`read_layout`: Read layout inference results, including the 3'-adapter sequence and the poly(A) fraction.
46 changes: 33 additions & 13 deletions docs/guides/installation.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,48 @@
Installation
============

This section describes how to install `HTSinfer` using Conda.
This section describes how to install `HTSinfer`.

Clone the Repository and Install Dependencies
---------------------------------------------
Install using Conda
-------------------

To install `HTSinfer`, first clone the repository and install the dependencies via `Conda <https://docs.conda.io/en/latest/miniconda.html>`_:
The easiest and quickest installation method is via `Mamba <https://mamba.readthedocs.io/en/latest/installation.html>`_ or `Conda <https://docs.conda.io/en/latest/miniconda.html>`_.
`HTSinfer` is available as part of the `Bioconda <https://anaconda.org/bioconda/htsinfer>`_ channel.

To create a new Conda environment with `HTSinfer` and its dependencies installed, run:

.. code-block:: bash
mamba create --name htsinfer bioconda::htsinfer
Then, activate the `htsinfer` Conda environment with:

.. code-block:: bash
conda activate htsinfer
To install `HTSinfer` in your current environment, run:

.. code-block:: bash
mamba install bioconda::htsinfer
Install from GitHub
-------------------

If you would like to contribute to the development of `HTSinfer`, or wishing to use unreleased versions, you can install `HTSinfer` from the `GitHub <https://github.com/zavolanlab/htsinfer>`_.
First clone the repository and install the dependencies via `Conda <https://docs.conda.io/en/latest/miniconda.html>`_:

.. code-block:: bash
git clone https://github.com/zavolanlab/htsinfer.git
cd htsinfer
conda env create --file environment.yml
mamba env create --file environment.yml
# Alternatively, to install with development dependencies,
# run the following instead
conda env create --file environment-dev.ymls
.. note::

Creating the environment may take some time. It is strongly recommended to install `Mamba <https://mamba.readthedocs.io/en/latest/installation.html>`_ and replace :code:`conda` with :code:`mamba` in the previous commands for faster installation.

Activate the Conda Environment
------------------------------
mamba env create --file environment-dev.ymls
After the installation is complete, activate the :code:`htsinfer` Conda environment with:

Expand Down
13 changes: 3 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,18 @@ This documentation will guide you through installation and usage. It also contai

Home <self>

Documentation
-------------

.. toctree::
:caption: Documentation
:maxdepth: 1

guides/installation
guides/usage
guides/examples

.. toctree::
:caption: API Overview
:caption: API overview
:maxdepth: 1

modules/modules

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
indices_and_tables

8 changes: 8 additions & 0 deletions docs/indices_and_tables.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Indices and tables
------------------

.. toctree::
:maxdepth: 1

genindex
modindex

0 comments on commit 3971d5e

Please sign in to comment.