Skip to content

Commit

Permalink
ADD: intro.rst: Host gene and make-vcf subcommand
Browse files Browse the repository at this point in the history
  • Loading branch information
thiago-miller committed Dec 6, 2019
1 parent ad37b40 commit 4d5ab37
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ Parental gene
The **gene** which **underwent retrotransposition** process,
giving rise to the retrocopy.

Host gene
It may happen that the retrotransposition occurs **inside**
another gene - which in turn is called the **host** gene
for this retrocopy.

Genomic position
The genome **coordinate** where occured the retrocopy
**integration** (chromosome:start-end). It includes the
Expand All @@ -59,13 +64,15 @@ How it works
============

sideRETRO compiles to an executable called :code:`sider`,
which has two subcommands: :code:`process-sample` and
:code:`merge-call`. The :code:`process-sample` subcommand
reads a list of SAM/BAM files, and captures **abnormal reads**
that must be related to an event of retrocopy. All those data is
saved to a **SQLite3 database** and then we come to the second
step :code:`merge-call`, which **processes** the database and
**annotate** all the retrocopies found.
which has three subcommands: :code:`process-sample`,
:code:`merge-call` and :code:`make-vcf`. The :code:`process-sample`
subcommand reads a list of SAM/BAM files, and captures
**abnormal reads** that must be related to an event of retrocopy.
All those data is saved to a **SQLite3 database** and then we come
to the second step :code:`merge-call`, which **processes** the database
and **annotate** all the retrocopies found. Finally we can run the
subcommand :code:`make-vcf` and generate an annotated retrocopy
`VCF <https://samtools.github.io/hts-specs/VCFv4.2.pdf>`_.

.. code-block:: sh
Expand All @@ -82,13 +89,18 @@ step :code:`merge-call`, which **processes** the database and
--input-file='my-bam-list.txt'
$ ls -1
my-genome.fa
my-annotation.gtf
my-bam-list.txt
out.db
# Run merge-call step
$ sider merge-call --in-place out.db
# Run make-vcf step
$ sider make-vcf \
--reference-file='my-genome.fa' out.db
Take a look at the manual page for :ref:`installation <chap_installation>`
and :ref:`usage <chap_usage>` information. Also for more details about
the algorithm, see our :ref:`methodology <chap_methodology>`.
Expand Down

0 comments on commit 4d5ab37

Please sign in to comment.