Deploying to gh-pages from @ 4b2fae3 🚀

.buildinfo

@@ -1,4 +1,4 @@
 # 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: 32f993692c99819ed0fcaa2703aefb24
+config: c19ed4e4ac9900edcee450f7dd423bbe
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/index.html

@@ -4,8 +4,8 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
 
-    <!-- Generated with Sphinx 7.2.2 and Furo 2023.08.19 -->
-        <title>Overview: module code - rds2py 0.3.0 documentation</title>
+    <!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19 -->
+        <title>Overview: module code - rds2py 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -122,7 +122,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">rds2py 0.3.0 documentation</div></a>
+      <a href="../index.html"><div class="brand">rds2py 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -145,7 +145,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">rds2py 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">rds2py 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -234,7 +234,7 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../_static/documentation_options.js?v=4621528c"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>

_modules/rds2py/interface.html

@@ -4,8 +4,8 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />
 
-    <!-- Generated with Sphinx 7.2.2 and Furo 2023.08.19 -->
-        <title>rds2py.interface - rds2py 0.3.0 documentation</title>
+    <!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19 -->
+        <title>rds2py.interface - rds2py 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -122,7 +122,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../index.html"><div class="brand">rds2py 0.3.0 documentation</div></a>
+      <a href="../../index.html"><div class="brand">rds2py 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -145,7 +145,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
 
 
-  <span class="sidebar-brand-text">rds2py 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">rds2py 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -342,9 +342,8 @@ <h1>Source code for rds2py.interface</h1><div class="highlight"><pre>
 <span class="k">def</span> <span class="nf">as_summarized_experiment</span><span class="p">(</span>
     <span class="n">robj</span><span class="p">:</span> <span class="n">MutableMapping</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="n">SummarizedExperiment</span><span class="p">,</span> <span class="n">SingleCellExperiment</span><span class="p">]:</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;Read an R object as a</span>
-<span class="sd">    :py:class:`~singlecellexperiment.SingleCellExperiment.SingleCellExperiment`</span>
-<span class="sd">    or :py:class:`~summarizedexperiment.SummarizedExperiment.SummarizedExperiment`.</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Read an R object as a :py:class:`~singlecellexperiment.SingleCellExperiment.SingleCellExperiment` or</span>
+<span class="sd">    :py:class:`~summarizedexperiment.SummarizedExperiment.SummarizedExperiment`.</span>
 
 <span class="sd">    Note: This function demonstrates how to parse a complex RDS object.</span>
 
@@ -365,7 +364,6 @@ <h1>Source code for rds2py.interface</h1><div class="highlight"><pre>
 <span class="sd">    Returns:</span>
 <span class="sd">        Union[SummarizedExperiment, SingleCellExperiment]: A `SummarizedExperiment` or</span>
 <span class="sd">        `SingleCellExperiment` from the R object.</span>
-
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">_cls</span> <span class="o">=</span> <span class="n">get_class</span><span class="p">(</span><span class="n">robj</span><span class="p">)</span>
 
@@ -503,7 +501,7 @@ <h1>Source code for rds2py.interface</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../../_static/documentation_options.js?v=4621528c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=32e29ea5"></script>

_modules/rds2py/parser.html

@@ -4,8 +4,8 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />
 
-    <!-- Generated with Sphinx 7.2.2 and Furo 2023.08.19 -->
-        <title>rds2py.parser - rds2py 0.3.0 documentation</title>
+    <!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19 -->
+        <title>rds2py.parser - rds2py 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -122,7 +122,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../index.html"><div class="brand">rds2py 0.3.0 documentation</div></a>
+      <a href="../../index.html"><div class="brand">rds2py 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -145,7 +145,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
 
 
-  <span class="sidebar-brand-text">rds2py 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">rds2py 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -284,7 +284,7 @@ <h1>Source code for rds2py.parser</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../../_static/documentation_options.js?v=4621528c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=32e29ea5"></script>

_modules/rds2py/pdf.html

@@ -4,8 +4,8 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />
 
-    <!-- Generated with Sphinx 7.2.2 and Furo 2023.08.19 -->
-        <title>rds2py.pdf - rds2py 0.3.0 documentation</title>
+    <!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19 -->
+        <title>rds2py.pdf - rds2py 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -122,7 +122,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../index.html"><div class="brand">rds2py 0.3.0 documentation</div></a>
+      <a href="../../index.html"><div class="brand">rds2py 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -145,7 +145,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
 
 
-  <span class="sidebar-brand-text">rds2py 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">rds2py 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -243,7 +243,7 @@ <h1>Source code for rds2py.pdf</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="as_pandas_from_dframe">
 <a class="viewcode-back" href="../../api/rds2py.html#rds2py.pdf.as_pandas_from_dframe">[docs]</a>
 <span class="k">def</span> <span class="nf">as_pandas_from_dframe</span><span class="p">(</span><span class="n">robj</span><span class="p">:</span> <span class="n">MutableMapping</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DataFrame</span><span class="p">:</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;Convert a realized R object to a pandas data frame representation</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Convert a realized R object to a pandas data frame representation.</span>
 
 <span class="sd">    Args:</span>
 <span class="sd">        robj (MutableMapping): Object parsed from the `RDS` file.</span>
@@ -312,7 +312,7 @@ <h1>Source code for rds2py.pdf</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../../_static/documentation_options.js?v=4621528c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=32e29ea5"></script>

_sources/index.md.txt

@@ -1,6 +1,6 @@
 # rds2py
 
-Parse, extract and create Python representations for datasets stored in RDS files. It supports Bioconductor's `SummarizedExperiment` and `SingleCellExperiment` objects. This is possible because of [Aaron's rds2cpp library](https://github.com/LTLA/rds2cpp). 
+Parse, extract and create Python representations for datasets stored in RDS files. It supports Bioconductor's `SummarizedExperiment` and `SingleCellExperiment` objects. This is possible because of [Aaron's rds2cpp library](https://github.com/LTLA/rds2cpp).
 
 The package uses memory views (except for strings) so that we can access the same memory from C++ space in Python (through Cython of course). This is especially useful for large datasets so we don't make copies of data.
 

_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.3.0',
+    VERSION: '0.3.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

api/modules.html

@@ -5,8 +5,8 @@
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
 <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="rds2py package" href="rds2py.html" /><link rel="prev" title="Changelog" href="../changelog.html" />
 
-    <!-- Generated with Sphinx 7.2.2 and Furo 2023.08.19 -->
-        <title>rds2py - rds2py 0.3.0 documentation</title>
+    <!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19 -->
+        <title>rds2py - rds2py 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">rds2py 0.3.0 documentation</div></a>
+      <a href="../index.html"><div class="brand">rds2py 0.3.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -146,7 +146,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">rds2py 0.3.0 documentation</span>
+  <span class="sidebar-brand-text">rds2py 0.3.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -205,7 +205,7 @@ <h1>rds2py<a class="headerlink" href="#rds2py" title="Link to this heading">#</a
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="rds2py.html">rds2py package</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="rds2py.html#submodules">Submodules</a></li>
-<li class="toctree-l2"><a class="reference internal" href="rds2py.html#rds2py-core-module">rds2py.core module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rds2py.html#module-rds2py.core">rds2py.core module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.core.PyParsedObject"><code class="docutils literal notranslate"><span class="pre">PyParsedObject</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="rds2py.html#rds2py.core.PyParsedObject.__new__"><code class="docutils literal notranslate"><span class="pre">PyParsedObject.__new__()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="rds2py.html#rds2py.core.PyParsedObject.__reduce__"><code class="docutils literal notranslate"><span class="pre">PyParsedObject.__reduce__()</span></code></a></li>
@@ -237,24 +237,24 @@ <h1>rds2py<a class="headerlink" href="#rds2py" title="Link to this heading">#</a
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.core.__setstate_cython__"><code class="docutils literal notranslate"><span class="pre">__setstate_cython__()</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="rds2py.html#rds2py-interface-module">rds2py.interface module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rds2py.html#module-rds2py.interface">rds2py.interface module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.interface.as_dense_matrix"><code class="docutils literal notranslate"><span class="pre">as_dense_matrix()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.interface.as_pandas"><code class="docutils literal notranslate"><span class="pre">as_pandas()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.interface.as_sparse_matrix"><code class="docutils literal notranslate"><span class="pre">as_sparse_matrix()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.interface.as_summarized_experiment"><code class="docutils literal notranslate"><span class="pre">as_summarized_experiment()</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="rds2py.html#rds2py-parser-module">rds2py.parser module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rds2py.html#module-rds2py.parser">rds2py.parser module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.parser.get_class"><code class="docutils literal notranslate"><span class="pre">get_class()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.parser.read_rds"><code class="docutils literal notranslate"><span class="pre">read_rds()</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="rds2py.html#rds2py-pdf-module">rds2py.pdf module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rds2py.html#module-rds2py.pdf">rds2py.pdf module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.pdf.as_pandas_from_data_frame"><code class="docutils literal notranslate"><span class="pre">as_pandas_from_data_frame()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="rds2py.html#rds2py.pdf.as_pandas_from_dframe"><code class="docutils literal notranslate"><span class="pre">as_pandas_from_dframe()</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="rds2py.html#module-contents">Module contents</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rds2py.html#module-rds2py">Module contents</a></li>
 </ul>
 </li>
 </ul>
@@ -310,7 +310,7 @@ <h1>rds2py<a class="headerlink" href="#rds2py" title="Link to this heading">#</a
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=e259d695"></script>
+</div><script src="../_static/documentation_options.js?v=4621528c"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>