Skip to content

Commit

Permalink
site init
Browse files Browse the repository at this point in the history
  • Loading branch information
CaoTianze committed May 5, 2023
1 parent 25a8a59 commit 79bb3f3
Show file tree
Hide file tree
Showing 65 changed files with 8,427 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -147,5 +147,4 @@ cython_debug/
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/
site
.idea/
129 changes: 129 additions & 0 deletions site/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="/img/favicon.ico" />
<title>plotnineSeqSuite Documentation</title>
<link rel="stylesheet" href="/css/theme.css" />
<link rel="stylesheet" href="/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />

<script src="/js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="/." class="icon icon-home"> plotnineSeqSuite Documentation
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="/.">Getting Started</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/col_schemes/">color schemes</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/font/">font</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/geom_alignedSeq/">geom_alignedSeq</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/geom_logo/">geom_logo</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/geom_seqBar/">geom_seqBar</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/theme/">theme</a>
</li>
</ul>
</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/.">plotnineSeqSuite Documentation</a>

</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">


<h1 id="404-page-not-found">404</h1>

<p><strong>Page not found</strong></p>


</div>
</div><footer>

<hr/>

<div role="contentinfo">
<!-- Copyright etc -->
</div>

Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

</div>
</div>

</section>

</div>

<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">



</span>
</div>
<script>var base_url = '/';</script>
<script src="/js/theme_extra.js" defer></script>
<script src="/js/theme.js" defer></script>
<script src="/search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>

</body>
</html>
Binary file added site/accepted_input_formats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/bar_accepted_input_formats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/bar_no_sequence_letter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
191 changes: 191 additions & 0 deletions site/col_schemes/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>color schemes - plotnineSeqSuite Documentation</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />

<script>
// Current page data
var mkdocs_page_name = "color schemes";
var mkdocs_page_input_path = "col_schemes.md";
var mkdocs_page_url = null;
</script>

<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> plotnineSeqSuite Documentation
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Getting Started</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">color schemes</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#function-make_col_schemename-str-custom-scheme-chars-optionalliststr-none-groups-optionallistint-none-cols-optionallistint-none-values-optionallistint-none-dict">function make_col_scheme(name: str = 'Custom Scheme', chars: Optional[list[str]] = None, groups: Optional[list[int]] = None, cols: Optional[list[int]] = None, values: Optional[list[int]] = None) -&gt; dict</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#name">name</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#chars">chars</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#groups">groups</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#cols">cols</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#values">values</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#function-get_col_schemecol_scheme-str-seq_type-str-auto-dict">function get_col_scheme(col_scheme: str, seq_type: str = 'AUTO') -&gt; dict</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#col_scheme">col_scheme</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#seq_type">seq_type</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../font/">font</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../geom_alignedSeq/">geom_alignedSeq</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../geom_logo/">geom_logo</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../geom_seqBar/">geom_seqBar</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../theme/">theme</a>
</li>
</ul>
</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">plotnineSeqSuite Documentation</a>

</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>color schemes</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">

<h1 id="color-schemes">color schemes</h1>
<p>Default color schemes: chemistry, chemistry2, hydrophobicity, nucleotide, nucleotide2, base_pairing, clustalx, taylor.</p>
<h2 id="function-make_col_schemename-str-custom-scheme-chars-optionalliststr-none-groups-optionallistint-none-cols-optionallistint-none-values-optionallistint-none-dict"><em>function</em> make_col_scheme(name: str = 'Custom Scheme', chars: Optional[list[str]] = None, groups: Optional[list[int]] = None, cols: Optional[list[int]] = None, values: Optional[list[int]] = None) -&gt; dict</h2>
<pre><code class="language-python">from plotnineseqsuite.col_schemes import make_col_scheme
cs1 = make_col_scheme(chars=['A', 'T', 'C', 'G'], groups=['gr1', 'gr1', 'gr2', 'gr2'],cols=['purple', 'purple', 'blue', 'blue'])
cs2 = make_col_scheme(chars=['A', 'T', 'C', 'G'], values=[1,2,3,4])
</code></pre>
<p>The function is used to create custom color style themes.</p>
<h3 id="name">name</h3>
<p>Name of custom scheme. It will display in legend.</p>
<h3 id="chars">chars</h3>
<p>Letters will used to plot.</p>
<h3 id="groups">groups</h3>
<p>Used in a custom discrete color scheme. It groups letters.</p>
<h3 id="cols">cols</h3>
<p>Used in a custom discrete color scheme. It represents the RGB value of the grouped color.</p>
<h3 id="values">values</h3>
<p>Used in a custom continuous color scheme. It represents the numeric value of the corresponding letter.</p>
<h2 id="function-get_col_schemecol_scheme-str-seq_type-str-auto-dict"><em>function</em> get_col_scheme(col_scheme: str, seq_type: str = 'AUTO') -&gt; dict</h2>
<p>This function is used to get the built-in color theme of the type of the given sequence.</p>
<pre><code class="language-python">from plotnineseqsuite.col_schemes import get_col_scheme
col_df = get_col_scheme(col_scheme='chemistry')
</code></pre>
<h3 id="col_scheme">col_scheme</h3>
<p>One of the default color schemes.</p>
<h3 id="seq_type">seq_type</h3>
<p>AA or DNA or RNA</p>

</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href=".." class="btn btn-neutral float-left" title="Getting Started"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../font/" class="btn btn-neutral float-right" title="font">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>

<div role="contentinfo">
<!-- Copyright etc -->
</div>

Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

</div>
</div>

</section>

</div>

<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">


<span><a href=".." style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../font/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>

</body>
</html>
Binary file added site/combining_plots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/css/fonts/Roboto-Slab-Bold.woff
Binary file not shown.
Binary file added site/css/fonts/Roboto-Slab-Bold.woff2
Binary file not shown.
Binary file added site/css/fonts/Roboto-Slab-Regular.woff
Binary file not shown.
Binary file added site/css/fonts/Roboto-Slab-Regular.woff2
Binary file not shown.
Binary file added site/css/fonts/fontawesome-webfont.eot
Binary file not shown.
Loading

0 comments on commit 79bb3f3

Please sign in to comment.