Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
Damien Marsic(Portonbio) authored and Damien Marsic(Portonbio) committed Jun 18, 2020
1 parent eba909a commit 070fe19
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 16 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/pm-doc.doctree
Binary file not shown.
12 changes: 4 additions & 8 deletions docs/_build/html/_sources/pm-doc.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ Bioconda recipe and package:
Windows executable:
https://sourceforge.net/projects/parent-map/



|
Installation
============

Expand All @@ -52,8 +51,7 @@ To install the parent-map bioconda package, at the conda prompt type::
Windows users who prefer not to use a conda environment can install the Windows executable version of parent-map from here:
https://sourceforge.net/projects/parent-map/



|
Usage
=====

Expand Down Expand Up @@ -164,8 +162,7 @@ The same parameters are available in both modes (graphic and command-line) but s
* ColorizeOnly: -C
This option is to bypass the sequence analysis and to only colorize an existing -par.txt file. The file name (or path) needs to be entered after -C.



|
Output files
============

Expand Down Expand Up @@ -228,8 +225,7 @@ Alignments
**********
The -aln.txt file consists of two parts: the first concerns sequences derived from a single parent, while the second part is about sequences derived from multiple parents. In each part, variants derived from the same main parents are aligned together against their main parent. Only regions that differ from the parent in any of the variants are shown, and the region position is indicated by a number (numbering is the one defined in the parental sequence file as explained in :ref:`parents <parents>`). Sequence identity is shown using the identity symbol (default: '.'), gaps are shown using the gap symbol (default: '-'). Insertions are indicated by a gap in the parent sequence, deletions by a gap in the variant sequence. For substitutions, the actual sequence is shown. Increasing the region area (using the -e argument) allows to show more sequence context and to combine neighboring regions. The -aln.txt file is most useful for variants derived from a single parent (such as from insertion or targeted substitution libraries), as it allows to compare variants in discrete regions, which can be much larger in number and size when variants are derived from multiple parents (as in shuffled libraries).



|
Examples
========

Expand Down
12 changes: 12 additions & 0 deletions docs/_build/html/pm-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ <h1>Overview<a class="headerlink" href="#overview" title="Permalink to this head
<dt>Windows executable:</dt><dd><p><a class="reference external" href="https://sourceforge.net/projects/parent-map/">https://sourceforge.net/projects/parent-map/</a></p>
</dd>
</dl>
<div class="line-block">
<div class="line"><br /></div>
</div>
</div>
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
Expand All @@ -67,6 +70,9 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
</div>
<p>Windows users who prefer not to use a conda environment can install the Windows executable version of parent-map from here:
<a class="reference external" href="https://sourceforge.net/projects/parent-map/">https://sourceforge.net/projects/parent-map/</a></p>
<div class="line-block">
<div class="line"><br /></div>
</div>
</div>
<div class="section" id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h1>
Expand Down Expand Up @@ -213,6 +219,9 @@ <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this he
<blockquote>
<div><p>This option is to bypass the sequence analysis and to only colorize an existing -par.txt file. The file name (or path) needs to be entered after -C.</p>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
</div>
</div>
<div class="section" id="output-files">
Expand Down Expand Up @@ -331,6 +340,9 @@ <h2>Sequence definitions<a class="headerlink" href="#sequence-definitions" title
<div class="section" id="alignments">
<h2>Alignments<a class="headerlink" href="#alignments" title="Permalink to this headline"></a></h2>
<p>The -aln.txt file consists of two parts: the first concerns sequences derived from a single parent, while the second part is about sequences derived from multiple parents. In each part, variants derived from the same main parents are aligned together against their main parent. Only regions that differ from the parent in any of the variants are shown, and the region position is indicated by a number (numbering is the one defined in the parental sequence file as explained in <span class="xref std std-ref">parents</span>). Sequence identity is shown using the identity symbol (default: ‘.’), gaps are shown using the gap symbol (default: ‘-‘). Insertions are indicated by a gap in the parent sequence, deletions by a gap in the variant sequence. For substitutions, the actual sequence is shown. Increasing the region area (using the -e argument) allows to show more sequence context and to combine neighboring regions. The -aln.txt file is most useful for variants derived from a single parent (such as from insertion or targeted substitution libraries), as it allows to compare variants in discrete regions, which can be much larger in number and size when variants are derived from multiple parents (as in shuffled libraries).</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
</div>
</div>
<div class="section" id="examples">
Expand Down
12 changes: 4 additions & 8 deletions docs/pm-doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ Bioconda recipe and package:
Windows executable:
https://sourceforge.net/projects/parent-map/



|
Installation
============

Expand All @@ -52,8 +51,7 @@ To install the parent-map bioconda package, at the conda prompt type::
Windows users who prefer not to use a conda environment can install the Windows executable version of parent-map from here:
https://sourceforge.net/projects/parent-map/



|
Usage
=====

Expand Down Expand Up @@ -164,8 +162,7 @@ The same parameters are available in both modes (graphic and command-line) but s
* ColorizeOnly: -C
This option is to bypass the sequence analysis and to only colorize an existing -par.txt file. The file name (or path) needs to be entered after -C.



|
Output files
============

Expand Down Expand Up @@ -228,8 +225,7 @@ Alignments
**********
The -aln.txt file consists of two parts: the first concerns sequences derived from a single parent, while the second part is about sequences derived from multiple parents. In each part, variants derived from the same main parents are aligned together against their main parent. Only regions that differ from the parent in any of the variants are shown, and the region position is indicated by a number (numbering is the one defined in the parental sequence file as explained in :ref:`parents <parents>`). Sequence identity is shown using the identity symbol (default: '.'), gaps are shown using the gap symbol (default: '-'). Insertions are indicated by a gap in the parent sequence, deletions by a gap in the variant sequence. For substitutions, the actual sequence is shown. Increasing the region area (using the -e argument) allows to show more sequence context and to combine neighboring regions. The -aln.txt file is most useful for variants derived from a single parent (such as from insertion or targeted substitution libraries), as it allows to compare variants in discrete regions, which can be much larger in number and size when variants are derived from multiple parents (as in shuffled libraries).



|
Examples
========

Expand Down

0 comments on commit 070fe19

Please sign in to comment.