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
File renamed without changes.
File renamed without changes.
39 changes: 39 additions & 0 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Examples
========

Competition calculation
------------------------

Example of the output generated when the competition algorithm analyses the
``pbr322.toy.fa`` sequence. These results are described in the Bioinformatics
citation (see :doc:`citation`).

Input file
~~~~~~~~~~

:download:`pbr322.toy.fa <_static/examples/pbr322.toy.fa>`

Command
~~~~~~~

.. code-block:: bash

sist -f pbr322.toy.fa -a A -o pbr322.toy.compete.txt -b -p -r

Output files
~~~~~~~~~~~~

* :download:`one_line.pbr322.toy.fa <_static/examples/one_line.pbr322.toy.fa>`,
the sequence file format required by Inverted Repeat Finder (IRF)
* :download:`one_line.pbr322.toy.fa.2.10.10.80.10.20.10000.100.1.html <_static/examples/one_line.pbr322.toy.fa.2.10.10.80.10.20.10000.100.1.html>`,
an IRF output file
* :download:`one_line.pbr322.toy.fa.2.10.10.80.10.20.10000.100.1.txt.html <_static/examples/one_line.pbr322.toy.fa.2.10.10.80.10.20.10000.100.1.txt.html>`,
an IRF output file
* :download:`pbr322.toy.compete.txt <_static/examples/pbr322.toy.compete.txt>`,
the SIST output file

Figure
~~~~~~

:download:`all.eps <_static/examples/all.eps>` represents graphically the
output shown in ``pbr322.toy.compete.txt``.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,6 @@ Run a competition calculation and write the result to a file:
user-guide
installation
source-usage
examples
development
citation
19 changes: 2 additions & 17 deletions docs/source/source-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,20 +154,5 @@ in the current working directory when these calculations are run.
Example calculation
-------------------

The repository contains an example competition calculation based on
``pbr322.toy.fa``.

The command is:

.. code-block:: bash

sist \
-f pbr322.toy.fa \
-a A \
-o pbr322.toy.compete.txt \
-b \
-p \
-r

The example directory also contains IRF intermediate output and an EPS
representation of the competition result.
See :doc:`examples` for a full worked competition calculation, including
downloadable input/output files and an EPS representation of the result.
15 changes: 0 additions & 15 deletions example/README.txt

This file was deleted.

Loading