Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
Welcome to SPRAS's documentation!
=================================

SPRAS is a Python package that builds on Snakemake and Docker to provide a standardized, reproducible, and scalable framework for applying pathway reconstruction
SPRAS is a Python package that builds on `Snakemake <https://snakemake.readthedocs.io>`_ and
`Docker <https://en.wikipedia.org/wiki/Docker_(software)>`_ to provide a standardized,
reproducible, and scalable framework for applying pathway reconstruction
methods (PRMs) to omics data.

.. image:: _static/spras-overview.png
Expand All @@ -27,7 +29,12 @@ methods (PRMs) to omics data.

about
install
vignettes
usage

.. toctree::
:maxdepth: 1
:caption: Manual

output

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions docs/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ and rows providing attributes for each edge. The header row is
``Node1 Node2 Rank Direction``. Each row lists the two nodes
that are connected with an edge, the rank for that edge, and a
directionality column to indicate whether the edge is directed or
undirected. The directionality values are either a ‘U’ for an undirected
edge or a ‘D’ for a directed edge, where the direction is from Node1 to
undirected. The directionality values are either a 'U' for an undirected
edge or a 'D' for a directed edge, where the direction is from Node1 to
Node2. Pathways that do not contain ranked edges can output all 1s in
the Rank column.

Expand Down
12 changes: 12 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Using SPRAS
===========

SPRAS is run through `Snakemake <https://snakemake.readthedocs.io/>`_, which comes
with the SPRAS conda environment.

To run SPRAS, run the following command inside the ``spras`` directory,
specifying a ``config.yaml`` and the number of cores to run SPRAS with:

.. code-block:: bash

snakemake --cores 1 --configfile config.yaml
5 changes: 0 additions & 5 deletions docs/vignettes.rst

This file was deleted.

Loading