Skip to content

P
PRESCOTT
Commit c87411cf by Mustafa Tekpinar
Options

Updated the documentation.

parent 1b57c1f9
Showing with 81 additions and 81 deletions
docs/_build/html/.buildinfo
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: dbe0b599dc686a00746813e2a7a94d25
config: 5c84254d67e9b464e3ef5db2238ded56
tags: 645f666f9bcd5a90fca523b33c5a78b7
docs/_build/html/_sources/docker.rst.txt
Using PRESCOTT via Docker
Using ESCOTT via Docker
========================
Requirements
......@@ -60,7 +60,7 @@ you may not need ‘sudo’ word before the docker command at all.
.. code:: bash
sudo docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/myexample \
tekpinar/esgemme-docker:v1.4.0
tekpinar/prescott-docker:v1.5.0
You are in the container (your virtual operating system) now. You
created a folder called myexample in your container with the previous
......@@ -81,7 +81,7 @@ In this step, we will use only evolutionary information from an MSA file:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta
escott aliBLAT.fasta -f aliBLAT.fasta
After a few minutes of calculation, you must see at least two files named
BLAT_normPred_evolCombi.txt and BLAT_normPred_evolCombi.png. You have
......@@ -93,7 +93,7 @@ evolutionary information:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb
escott aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb
Predicting the effect of a subset of single point mutations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
......@@ -111,13 +111,13 @@ structural information. First, let's do it without structural information:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta -m Stiffler_2015_BLAT_ECOLX.mut
escott aliBLAT.fasta -f aliBLAT.fasta -m Stiffler_2015_BLAT_ECOLX.mut
You can include structural information in the following way:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb \
escott aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb \
-m Stiffler_2015_BLAT_ECOLX.mut
You will have BLAT_normPred_evolCombi.txt file in your folder. However, the output
......@@ -127,7 +127,7 @@ In addition, you won't have a png file like in the previous case.
Multiple point mutation calculations
------------------------------------
Sometimes, we need to see effects of double or triple mutations. PRESCOTT can
Sometimes, we need to see effects of double or triple mutations. ESCOTT can
perform calculations if you provide a mut file. In this case, the mut file must
have the following format:
......
docs/_build/html/_static/documentation_options.js
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.4.0',
VERSION: '1.5.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
......
docs/_build/html/analysis.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Analyzing and Modifying the PRESCOTT Output &mdash; prescott 1.4.0 documentation</title>
<title>Analyzing and Modifying the PRESCOTT Output &mdash; prescott 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......
docs/_build/html/docker.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Using PRESCOTT via Docker &mdash; prescott 1.4.0 documentation</title>
<title>Using ESCOTT via Docker &mdash; prescott 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......@@ -44,7 +44,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Using PRESCOTT via Docker</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Using ESCOTT via Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getting-the-example-input-data">Getting the example input data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#single-point-mutation-calculations">Single point mutation calculations</a><ul>
......@@ -75,7 +75,7 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Using PRESCOTT via Docker</li>
<li class="breadcrumb-item active">Using ESCOTT via Docker</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/docker.rst.txt" rel="nofollow"> View page source</a>
</li>
......@@ -85,8 +85,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="using-prescott-via-docker">
<h1>Using PRESCOTT via Docker<a class="headerlink" href="#using-prescott-via-docker" title="Permalink to this heading"></a></h1>
<section id="using-escott-via-docker">
<h1>Using ESCOTT via Docker<a class="headerlink" href="#using-escott-via-docker" title="Permalink to this heading"></a></h1>
<section id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
<p>You need to have docker installed on your machine. You can consult the
......@@ -128,7 +128,7 @@ file in fasta format:</p>
<p>If it shows you a list of options, you are on a good track. On MacOS,
you may not need ‘sudo’ word before the docker command at all.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo docker run -ti --rm --mount <span class="nv">type</span><span class="o">=</span>bind,source<span class="o">=</span><span class="nv">$PWD</span>,target<span class="o">=</span>/home/tekpinar/research/myexample <span class="se">\</span>
tekpinar/esgemme-docker:v1.4.0
tekpinar/prescott-docker:v1.5.0
</pre></div>
</div>
<p>You are in the container (your virtual operating system) now. You
......@@ -144,7 +144,7 @@ docker container are pointing to the same place.</p>
<section id="obtaining-the-entire-single-point-mutation-landscape">
<h3>Obtaining the entire single point mutation landscape<a class="headerlink" href="#obtaining-the-entire-single-point-mutation-landscape" title="Permalink to this heading"></a></h3>
<p>In this step, we will use only evolutionary information from an MSA file:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>esgemme aliBLAT.fasta -f aliBLAT.fasta
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>escott aliBLAT.fasta -f aliBLAT.fasta
</pre></div>
</div>
<p>After a few minutes of calculation, you must see at least two files named
......@@ -153,7 +153,7 @@ the entire single point mutational landscape of BLAT protein in these
files.</p>
<p>If you want to utilize structural information (highly recommended) as well as
evolutionary information:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>esgemme aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>escott aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb
</pre></div>
</div>
</section>
......@@ -168,11 +168,11 @@ Fortunately, we have an example mut in data folder of PRESCOTT repository.</p>
</div>
<p>Similar to the previous step, there are two possible ways to do the calculations: with or without
structural information. First, let’s do it without structural information:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>esgemme aliBLAT.fasta -f aliBLAT.fasta -m Stiffler_2015_BLAT_ECOLX.mut
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>escott aliBLAT.fasta -f aliBLAT.fasta -m Stiffler_2015_BLAT_ECOLX.mut
</pre></div>
</div>
<p>You can include structural information in the following way:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>esgemme aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb <span class="se">\</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>escott aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb <span class="se">\</span>
-m Stiffler_2015_BLAT_ECOLX.mut
</pre></div>
</div>
......@@ -184,7 +184,7 @@ In addition, you won’t have a png file like in the previous case.</p>
</section>
<section id="multiple-point-mutation-calculations">
<h2>Multiple point mutation calculations<a class="headerlink" href="#multiple-point-mutation-calculations" title="Permalink to this heading"></a></h2>
<p>Sometimes, we need to see effects of double or triple mutations. PRESCOTT can
<p>Sometimes, we need to see effects of double or triple mutations. ESCOTT can
perform calculations if you provide a mut file. In this case, the mut file must
have the following format:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>E26D:Y44R
......
docs/_build/html/genindex.html
......@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; prescott 1.4.0 documentation</title>
<title>Index &mdash; prescott 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......@@ -41,7 +41,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using PRESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the PRESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
......
docs/_build/html/index.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to esgemme’s documentation! &mdash; prescott 1.4.0 documentation</title>
<title>Welcome to esgemme’s documentation! &mdash; prescott 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......@@ -19,7 +19,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Using PRESCOTT via Docker" href="docker.html" />
<link rel="next" title="Using ESCOTT via Docker" href="docker.html" />
</head>
<body class="wy-body-for-nav">
......@@ -43,7 +43,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using PRESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the PRESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
......@@ -78,7 +78,7 @@
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using PRESCOTT via Docker</a><ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docker.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#getting-the-example-input-data">Getting the example input data</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#single-point-mutation-calculations">Single point mutation calculations</a></li>
......@@ -118,7 +118,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="docker.html" class="btn btn-neutral float-right" title="Using PRESCOTT via Docker" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="docker.html" class="btn btn-neutral float-right" title="Using ESCOTT via Docker" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
......
docs/_build/html/input-preparation.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Preparing Your Own Input &mdash; prescott 1.4.0 documentation</title>
<title>Preparing Your Own Input &mdash; prescott 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......
docs/_build/html/installation.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation &mdash; prescott 1.4.0 documentation</title>
<title>Installation &mdash; prescott 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......
docs/_build/html/search.html
......@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; prescott 1.4.0 documentation</title>
<title>Search &mdash; prescott 1.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
......@@ -44,7 +44,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using PRESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the PRESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
......
docs/_build/latex/prescott.aux
......@@ -20,11 +20,11 @@
\providecommand\HyField@AuxAddToCoFields[2]{}
\babel@aux{english}{}
\newlabel{index::doc}{{}{1}{}{section*.2}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {1}Using PRESCOTT via Docker}{1}{chapter.1}\protected@file@percent }
\@writefile{toc}{\contentsline {chapter}{\numberline {1}Using ESCOTT via Docker}{1}{chapter.1}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{docker:using-prescott-via-docker}{{1}{1}{Using PRESCOTT via Docker}{chapter.1}{}}
\newlabel{docker::doc}{{1}{1}{Using PRESCOTT via Docker}{chapter.1}{}}
\newlabel{docker:using-escott-via-docker}{{1}{1}{Using ESCOTT via Docker}{chapter.1}{}}
\newlabel{docker::doc}{{1}{1}{Using ESCOTT via Docker}{chapter.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.1}Requirements}{1}{section.1.1}\protected@file@percent }
\newlabel{docker:requirements}{{1.1}{1}{Requirements}{section.1.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.2}Getting the example input data}{1}{section.1.2}\protected@file@percent }
......
docs/_build/latex/prescott.fdb_latexmk
# Fdb version 3
["makeindex prescott.idx"] 1691770116 "prescott.idx" "prescott.ind" "prescott" 1691770117
"prescott.idx" 1691770117 0 d41d8cd98f00b204e9800998ecf8427e "pdflatex"
["makeindex prescott.idx"] 1691770116 "prescott.idx" "prescott.ind" "prescott" 1695817598
"prescott.idx" 1695817597 0 d41d8cd98f00b204e9800998ecf8427e "pdflatex"
(generated)
"prescott.ilg"
"prescott.ind"
["pdflatex"] 1691770117 "prescott.tex" "prescott.pdf" "prescott" 1691770117
["pdflatex"] 1695817597 "prescott.tex" "prescott.pdf" "prescott" 1695817598
"/etc/texmf/web2c/texmf.cnf" 1686915816 475 c0e671620eb5563b2130f56340a5fde8 ""
"/usr/share/texlive/texmf-dist/fonts/map/fontname/texfonts.map" 1577235249 3524 cb3e574dea2d1052e39280babc910dc8 ""
"/usr/share/texlive/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm" 1136768653 3584 adb004a0c8e7c46ee66cad73671f37b4 ""
......@@ -138,15 +138,15 @@
"/usr/share/texmf/tex/latex/tex-gyre/tgtermes.sty" 1480098840 2211 af9b7d12507105a58a3e8e926996b827 ""
"/usr/share/texmf/tex/latex/tex-gyre/ts1qtm.fd" 1480098840 1160 de7b1cf70edab73c9f1704df2a9fdbbd ""
"/usr/share/texmf/web2c/texmf.cnf" 1644012257 39432 7155514e09a3d69036fac785183a21c2 ""
"/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map" 1691069360 165012 f177baa1c39a3ebd62c3096a43521a0d ""
"/var/lib/texmf/web2c/pdftex/pdflatex.fmt" 1691069528 1484752 57623038f8c12eac59712d2139a09a53 ""
"prescott.aux" 1691770117 6433 13cfc6b4bb8198f84c538eddeeb235ce "pdflatex"
"prescott.ind" 1691770116 0 d41d8cd98f00b204e9800998ecf8427e "makeindex prescott.idx"
"prescott.out" 1691770117 4711 c9f2e773136e992e346f95c229b25c19 "pdflatex"
"prescott.tex" 1691770114 25859 64a93b8dc31c91416335e6602bd3d6fc ""
"prescott.toc" 1691770117 1869 56be3fea396e9fd923a79473c924f50e "pdflatex"
"/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map" 1692610720 128028 f533b797fba58d231669ea19e894e23e ""
"/var/lib/texmf/web2c/pdftex/pdflatex.fmt" 1692610730 1455466 cf5d347cc06e6f91065ccb2619b82e95 ""
"prescott.aux" 1695817597 6425 d4a0cc942c15d7d060b85f0f9e02b550 "pdflatex"
"prescott.ind" 1694694190 0 d41d8cd98f00b204e9800998ecf8427e "makeindex prescott.idx"
"prescott.out" 1695817597 4701 4918ce853b06e7ffbb76675751d2708f "pdflatex"
"prescott.tex" 1695817596 25850 4bcc5c8c915860158ff9ba881b3f1df9 ""
"prescott.toc" 1695817597 1867 651c787e441d7670480cfc3502fbd769 "pdflatex"
"sphinx.sty" 1691571542 12780 919e6ba449302e2597e7722681a087c6 ""
"sphinxhighlight.sty" 1691770114 6679 76d10c62e0f0661410b46f5db6118e26 ""
"sphinxhighlight.sty" 1695817596 6679 76d10c62e0f0661410b46f5db6118e26 ""
"sphinxlatexadmonitions.sty" 1691571543 6238 2d867d769abf3f72abc17ef52adff78b ""
"sphinxlatexcontainers.sty" 1691571543 901 d3a3a1b7b2547f47ade2499350b5c420 ""
"sphinxlatexgraphics.sty" 1691571543 4840 a9578332b6f3b35e198751fb632c9b79 ""
......@@ -161,7 +161,7 @@
"sphinxlatexstyletext.sty" 1691571543 6177 c18841ce3fafc366cd3b145f8faa4c37 ""
"sphinxlatextables.sty" 1691571542 21848 2827eb0b11b99b185a8b77317d3e131c ""
"sphinxmanual.cls" 1691571543 4241 7b0d7a37df7b5715fb0dbd585c52ecdb ""
"sphinxmessages.sty" 1691770114 745 3f5fcd6cdd7964ed608767954a8ced6f ""
"sphinxmessages.sty" 1695817596 745 3f5fcd6cdd7964ed608767954a8ced6f ""
"sphinxoptionsgeometry.sty" 1691571542 2061 47bb34b8ed8a78823eb0c886abfb9f4d ""
"sphinxoptionshyperref.sty" 1691571543 1094 79beb8b8a3f10784f8cce804e0f9d3aa ""
"sphinxpackagefootnote.sty" 1691571543 15217 dd26fe418b6fb1b26b18f042a7f43d40 ""
......
docs/_build/latex/prescott.log
This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2022/dev/Debian) (preloaded format=pdflatex 2023.8.3) 11 AUG 2023 18:08
This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2022/dev/Debian) (preloaded format=pdflatex 2023.8.21) 27 SEP 2023 14:26
entering extended mode
restricted \write18 enabled.
%&-line parsing enabled.
......@@ -118,7 +118,7 @@ LaTeX Font Info: Overwriting math alphabet `\mathfrak' in version `bold'
Package: babel 2022/01/26 3.70 The Babel package
\babel@savecnt=\count272
\U@D=\dimen148
\l@unhyphenated=\language9
\l@unhyphenated=\language5
(/usr/share/texlive/texmf-dist/tex/generic/babel/txtbabel.def)
\bbl@readstream=\read2
......@@ -129,9 +129,9 @@ Language: english 2017/06/06 v3.3r English support from the babel system
Package babel Info: Hyphen rules for 'canadian' set to \l@english
(babel) (\language0). Reported on input line 102.
Package babel Info: Hyphen rules for 'australian' set to \l@ukenglish
(babel) (\language3). Reported on input line 105.
(babel) (\language4). Reported on input line 105.
Package babel Info: Hyphen rules for 'newzealand' set to \l@ukenglish
(babel) (\language3). Reported on input line 108.
(babel) (\language4). Reported on input line 108.
))
(/usr/share/texmf/tex/latex/tex-gyre/tgtermes.sty
Package: tgtermes 2009/09/27 v1.2 TeX Gyre Termes as default roman family
......@@ -827,15 +827,15 @@ Underfull \hbox (badness 7981) in paragraph at lines 627--630
Chapter 5.
(./prescott.ind) [13] (./prescott.aux)
Package rerunfilecheck Info: File `prescott.out' has not changed.
(rerunfilecheck) Checksum: C9F2E773136E992E346F95C229B25C19;4711.
(rerunfilecheck) Checksum: 4918CE853B06E7FFBB76675751D2708F;4701.
)
Here is how much of TeX's memory you used:
14655 strings out of 480129
233353 string characters out of 5893410
598153 words of memory out of 5000000
32199 multiletter control sequences out of 15000+600000
14655 strings out of 480204
233351 string characters out of 5895010
597904 words of memory out of 5000000
32190 multiletter control sequences out of 15000+600000
520869 words of font info for 70 fonts, out of 8000000 for 9000
82 hyphenation exceptions out of 8191
37 hyphenation exceptions out of 8191
70i,11n,76p,433b,568s stack positions out of 5000i,500n,10000p,200000b,80000s
{/usr/share/texmf/fonts/enc/dvips/tex-gyre/q-ts1.enc}{/usr/share/texmf/fonts/
enc/dvips/tex-gyre/q-ec.enc}</usr/share/texlive/texmf-dist/fonts/type1/public/a
......@@ -847,7 +847,7 @@ usr/share/texlive/texmf-dist/fonts/type1/public/txfonts/t1xbtt.pfb></usr/share/
texlive/texmf-dist/fonts/type1/public/txfonts/t1xtt.pfb></usr/share/texlive/tex
mf-dist/fonts/type1/public/txfonts/t1xtt.pfb></usr/share/texlive/texmf-dist/fon
ts/type1/public/txfonts/tcxtt.pfb>
Output written on prescott.pdf (17 pages, 164980 bytes).
Output written on prescott.pdf (17 pages, 165007 bytes).
PDF statistics:
259 PDF objects out of 1000 (max. 8388607)
220 compressed objects within 3 object streams
......
docs/_build/latex/prescott.out
\BOOKMARK [0][-]{chapter.1}{\376\377\000U\000s\000i\000n\000g\000\040\000P\000R\000E\000S\000C\000O\000T\000T\000\040\000v\000i\000a\000\040\000D\000o\000c\000k\000e\000r}{}% 1
\BOOKMARK [0][-]{chapter.1}{\376\377\000U\000s\000i\000n\000g\000\040\000E\000S\000C\000O\000T\000T\000\040\000v\000i\000a\000\040\000D\000o\000c\000k\000e\000r}{}% 1
\BOOKMARK [1][-]{section.1.1}{\376\377\000R\000e\000q\000u\000i\000r\000e\000m\000e\000n\000t\000s}{chapter.1}% 2
\BOOKMARK [1][-]{section.1.2}{\376\377\000G\000e\000t\000t\000i\000n\000g\000\040\000t\000h\000e\000\040\000e\000x\000a\000m\000p\000l\000e\000\040\000i\000n\000p\000u\000t\000\040\000d\000a\000t\000a}{chapter.1}% 3
\BOOKMARK [1][-]{section.1.3}{\376\377\000S\000i\000n\000g\000l\000e\000\040\000p\000o\000i\000n\000t\000\040\000m\000u\000t\000a\000t\000i\000o\000n\000\040\000c\000a\000l\000c\000u\000l\000a\000t\000i\000o\000n\000s}{chapter.1}% 4
......
docs/_build/latex/prescott.tex
......@@ -61,8 +61,8 @@
\title{prescott}
\date{Aug 11, 2023}
\release{1.4.0}
\date{Sep 27, 2023}
\release{1.5.0}
\author{Mustafa Tekpinar}
\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{Release}
......@@ -85,8 +85,8 @@
\sphinxstepscope
\chapter{Using PRESCOTT via Docker}
\label{\detokenize{docker:using-prescott-via-docker}}\label{\detokenize{docker::doc}}
\chapter{Using ESCOTT via Docker}
\label{\detokenize{docker:using-escott-via-docker}}\label{\detokenize{docker::doc}}
\section{Requirements}
\label{\detokenize{docker:requirements}}
......@@ -155,7 +155,7 @@ you may not need ‘sudo’ word before the docker command at all.
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sudo docker run \PYGZhy{}ti \PYGZhy{}\PYGZhy{}rm \PYGZhy{}\PYGZhy{}mount \PYG{n+nv}{type}\PYG{o}{=}bind,source\PYG{o}{=}\PYG{n+nv}{\PYGZdl{}PWD},target\PYG{o}{=}/home/tekpinar/research/myexample \PYG{l+s+se}{\PYGZbs{}}
tekpinar/esgemme\PYGZhy{}docker:v1.4.0
tekpinar/prescott\PYGZhy{}docker:v1.5.0
\end{sphinxVerbatim}
\sphinxAtStartPar
......@@ -180,7 +180,7 @@ docker container are pointing to the same place.
In this step, we will use only evolutionary information from an MSA file:
\begin{sphinxVerbatim}[commandchars=\\\{\}]
esgemme aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta
escott aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta
\end{sphinxVerbatim}
\sphinxAtStartPar
......@@ -194,7 +194,7 @@ If you want to utilize structural information (highly recommended) as well as
evolutionary information:
\begin{sphinxVerbatim}[commandchars=\\\{\}]
esgemme aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta \PYGZhy{}\PYGZhy{}pdbfile blat\PYGZhy{}af2.pdb
escott aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta \PYGZhy{}\PYGZhy{}pdbfile blat\PYGZhy{}af2.pdb
\end{sphinxVerbatim}
......@@ -215,14 +215,14 @@ Similar to the previous step, there are two possible ways to do the calculations
structural information. First, let’s do it without structural information:
\begin{sphinxVerbatim}[commandchars=\\\{\}]
esgemme aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta \PYGZhy{}m Stiffler\PYGZus{}2015\PYGZus{}BLAT\PYGZus{}ECOLX.mut
escott aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta \PYGZhy{}m Stiffler\PYGZus{}2015\PYGZus{}BLAT\PYGZus{}ECOLX.mut
\end{sphinxVerbatim}
\sphinxAtStartPar
You can include structural information in the following way:
\begin{sphinxVerbatim}[commandchars=\\\{\}]
esgemme aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta \PYGZhy{}\PYGZhy{}pdbfile blat\PYGZhy{}af2.pdb \PYG{l+s+se}{\PYGZbs{}}
escott aliBLAT.fasta \PYGZhy{}f aliBLAT.fasta \PYGZhy{}\PYGZhy{}pdbfile blat\PYGZhy{}af2.pdb \PYG{l+s+se}{\PYGZbs{}}
\PYGZhy{}m Stiffler\PYGZus{}2015\PYGZus{}BLAT\PYGZus{}ECOLX.mut
\end{sphinxVerbatim}
......@@ -236,7 +236,7 @@ In addition, you won’t have a png file like in the previous case.
\section{Multiple point mutation calculations}
\label{\detokenize{docker:multiple-point-mutation-calculations}}
\sphinxAtStartPar
Sometimes, we need to see effects of double or triple mutations. PRESCOTT can
Sometimes, we need to see effects of double or triple mutations. ESCOTT can
perform calculations if you provide a mut file. In this case, the mut file must
have the following format:
......
docs/_build/latex/prescott.toc
\babel@toc {english}{}\relax
\contentsline {chapter}{\numberline {1}Using PRESCOTT via Docker}{1}{chapter.1}%
\contentsline {chapter}{\numberline {1}Using ESCOTT via Docker}{1}{chapter.1}%
\contentsline {section}{\numberline {1.1}Requirements}{1}{section.1.1}%
\contentsline {section}{\numberline {1.2}Getting the example input data}{1}{section.1.2}%
\contentsline {section}{\numberline {1.3}Single point mutation calculations}{2}{section.1.3}%
......
docs/conf.py
......@@ -23,7 +23,7 @@ copyright = '2023, Mustafa Tekpinar'
author = 'Mustafa Tekpinar'
# The full version, including alpha/beta/rc tags
release = '1.4.0'
release = '1.5.0'
# -- General configuration ---------------------------------------------------
......
docs/docker.rst
Using PRESCOTT via Docker
Using ESCOTT via Docker
========================
Requirements
......@@ -60,7 +60,7 @@ you may not need ‘sudo’ word before the docker command at all.
.. code:: bash
sudo docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/myexample \
tekpinar/esgemme-docker:v1.4.0
tekpinar/prescott-docker:v1.5.0
You are in the container (your virtual operating system) now. You
created a folder called myexample in your container with the previous
......@@ -81,7 +81,7 @@ In this step, we will use only evolutionary information from an MSA file:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta
escott aliBLAT.fasta -f aliBLAT.fasta
After a few minutes of calculation, you must see at least two files named
BLAT_normPred_evolCombi.txt and BLAT_normPred_evolCombi.png. You have
......@@ -93,7 +93,7 @@ evolutionary information:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb
escott aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb
Predicting the effect of a subset of single point mutations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
......@@ -111,13 +111,13 @@ structural information. First, let's do it without structural information:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta -m Stiffler_2015_BLAT_ECOLX.mut
escott aliBLAT.fasta -f aliBLAT.fasta -m Stiffler_2015_BLAT_ECOLX.mut
You can include structural information in the following way:
.. code:: bash
esgemme aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb \
escott aliBLAT.fasta -f aliBLAT.fasta --pdbfile blat-af2.pdb \
-m Stiffler_2015_BLAT_ECOLX.mut
You will have BLAT_normPred_evolCombi.txt file in your folder. However, the output
......@@ -127,7 +127,7 @@ In addition, you won't have a png file like in the previous case.
Multiple point mutation calculations
------------------------------------
Sometimes, we need to see effects of double or triple mutations. PRESCOTT can
Sometimes, we need to see effects of double or triple mutations. ESCOTT can
perform calculations if you provide a mut file. In this case, the mut file must
have the following format:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment