Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
SOaAS
psot.repository
Commits
9139aefe
Commit
9139aefe
authored
Jul 26, 2017
by
Lukas Jelonek
Browse files
Add chapter on concepts
parent
5b3d5301
Changes
3
Hide whitespace changes
Inline
Side-by-side
docs/source/concepts.rst
0 → 100644
View file @
9139aefe
Concepts
========
PSOT is a system that executes bioinformatic tools on a file with protein
sequences and converts the results into easy to process json documents. It
contains a live mode that writes the results of already finished tools into
a directory, which can be polled and further processed, e.g. by a website
that displays results as they become ready.
Vocabulary
----------
Module
A module implements a bioinformatic tool and the corresponding json converter.
It is defined in a module manifest.
Profile
A profile is a set of modules that are executed during an execution of PSOT.
Profiles can override default parameters of modules.
Workflow
--------
1. Load all module manifests and profiles
2. Create an execution directory
3. Generate a nextflow script for the choosen profile in the execution directory
4. Run the nextflow script
5. Remove the execution directory
Structure of the Nextflow Script
----------------------------
1. Run all analyses in parallel
2. Convert all analyses in parallel
3. In live mode: generate a json document for each module and each sequence within the live directory
4. Join all json files into a single one containing all information
5. Split the large json file into separate files for each sequence
docs/source/index.rst
View file @
9139aefe
...
...
@@ -10,6 +10,7 @@ Welcome to PSOT - protein sequence observation tool's documentation!
:maxdepth: 2
:caption: Contents:
concepts
modules
...
...
docs/source/modules.rst
View file @
9139aefe
.. highlight:: yaml
Modules
=======
...
...
@@ -45,3 +46,4 @@ A module manifest has the following structure::
dbxref: UniProtKB/Swiss-Prot
These parameters can be overridden in the profile.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment