|
5 | 5 | <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html"><link rel="search" title="Search" href="../../search.html"> |
6 | 6 |
|
7 | 7 | <!-- Generated with Sphinx 8.2.3 and Furo 2025.12.19 --> |
8 | | - <title>summarizedexperiment.base - SummarizedExperiment 0.6.4 documentation</title> |
| 8 | + <title>summarizedexperiment.base - SummarizedExperiment 0.6.5 documentation</title> |
9 | 9 | <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" /> |
10 | 10 | <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=7bdb33bb" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="../../_static/mystnb.8ecb98da25f57f5357bf6f572d296f466b2cfe2517ffebfabe82451661e28f02.css" /> |
|
161 | 161 | </label> |
162 | 162 | </div> |
163 | 163 | <div class="header-center"> |
164 | | - <a href="../../index.html"><div class="brand">SummarizedExperiment 0.6.4 documentation</div></a> |
| 164 | + <a href="../../index.html"><div class="brand">SummarizedExperiment 0.6.5 documentation</div></a> |
165 | 165 | </div> |
166 | 166 | <div class="header-right"> |
167 | 167 | <div class="theme-toggle-container theme-toggle-header"> |
|
182 | 182 |
|
183 | 183 | <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html"> |
184 | 184 |
|
185 | | - <span class="sidebar-brand-text">SummarizedExperiment 0.6.4 documentation</span> |
| 185 | + <span class="sidebar-brand-text">SummarizedExperiment 0.6.5 documentation</span> |
186 | 186 |
|
187 | 187 | </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search"> |
188 | 188 | <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> |
@@ -1511,9 +1511,9 @@ <h1>Source code for summarizedexperiment.base</h1><div class="highlight"><pre> |
1511 | 1511 | <span class="k">return</span> <span class="n">obj</span></div> |
1512 | 1512 |
|
1513 | 1513 |
|
1514 | | - <span class="c1">######################################</span> |
1515 | | - <span class="c1">######>> col_data accessors <<########</span> |
1516 | | - <span class="c1">######################################</span> |
| 1514 | + <span class="c1">##########################################</span> |
| 1515 | + <span class="c1">######>> col/row data accessors <<########</span> |
| 1516 | + <span class="c1">##########################################</span> |
1517 | 1517 |
|
1518 | 1518 | <div class="viewcode-block" id="BaseSE.get_column_data_column"> |
1519 | 1519 | <a class="viewcode-back" href="../../api/summarizedexperiment.html#summarizedexperiment.base.BaseSE.get_column_data_column">[docs]</a> |
@@ -1550,7 +1550,46 @@ <h1>Source code for summarizedexperiment.base</h1><div class="highlight"><pre> |
1550 | 1550 | <span class="sd"> or as a reference to the (in-place-modified) original.</span> |
1551 | 1551 | <span class="sd"> """</span> |
1552 | 1552 | <span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_define_output</span><span class="p">(</span><span class="n">in_place</span><span class="p">)</span> |
1553 | | - <span class="n">output</span><span class="o">.</span><span class="n">_cols</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">_cols</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="n">column</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">in_place</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| 1553 | + <span class="n">output</span><span class="o">.</span><span class="n">_cols</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">_cols</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="n">column</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">in_place</span><span class="o">=</span><span class="n">in_place</span><span class="p">)</span> |
| 1554 | + <span class="k">return</span> <span class="n">output</span></div> |
| 1555 | + |
| 1556 | + |
| 1557 | +<div class="viewcode-block" id="BaseSE.get_row_data_column"> |
| 1558 | +<a class="viewcode-back" href="../../api/summarizedexperiment.html#summarizedexperiment.base.BaseSE.get_row_data_column">[docs]</a> |
| 1559 | + <span class="k">def</span><span class="w"> </span><span class="nf">get_row_data_column</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">column</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span> |
| 1560 | +<span class="w"> </span><span class="sd">"""Access a column from the ``row_data``.</span> |
| 1561 | + |
| 1562 | +<span class="sd"> Args:</span> |
| 1563 | +<span class="sd"> column:</span> |
| 1564 | +<span class="sd"> Name of the column to retrieve.</span> |
| 1565 | + |
| 1566 | +<span class="sd"> Returns:</span> |
| 1567 | +<span class="sd"> The content of the column.</span> |
| 1568 | +<span class="sd"> """</span> |
| 1569 | + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_rows</span><span class="o">.</span><span class="n">get_column</span><span class="p">(</span><span class="n">column</span><span class="p">)</span></div> |
| 1570 | + |
| 1571 | + |
| 1572 | +<div class="viewcode-block" id="BaseSE.set_row_data_column"> |
| 1573 | +<a class="viewcode-back" href="../../api/summarizedexperiment.html#summarizedexperiment.base.BaseSE.set_row_data_column">[docs]</a> |
| 1574 | + <span class="k">def</span><span class="w"> </span><span class="nf">set_row_data_column</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">column</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">in_place</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-></span> <span class="n">BaseSE</span><span class="p">:</span> |
| 1575 | +<span class="w"> </span><span class="sd">"""Set or replace a column in ``row_data``.</span> |
| 1576 | + |
| 1577 | +<span class="sd"> Args:</span> |
| 1578 | +<span class="sd"> column:</span> |
| 1579 | +<span class="sd"> Name of the column to set.</span> |
| 1580 | + |
| 1581 | +<span class="sd"> value:</span> |
| 1582 | +<span class="sd"> Values for the column. Must match the number of features (rows).</span> |
| 1583 | + |
| 1584 | +<span class="sd"> in_place:</span> |
| 1585 | +<span class="sd"> Whether to modify the ``BaseSE`` in place.</span> |
| 1586 | + |
| 1587 | +<span class="sd"> Returns:</span> |
| 1588 | +<span class="sd"> A modified ``BaseSE`` object, either as a copy of the original</span> |
| 1589 | +<span class="sd"> or as a reference to the (in-place-modified) original.</span> |
| 1590 | +<span class="sd"> """</span> |
| 1591 | + <span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_define_output</span><span class="p">(</span><span class="n">in_place</span><span class="p">)</span> |
| 1592 | + <span class="n">output</span><span class="o">.</span><span class="n">_rows</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">_rows</span><span class="o">.</span><span class="n">set_column</span><span class="p">(</span><span class="n">column</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">in_place</span><span class="o">=</span><span class="n">in_place</span><span class="p">)</span> |
1554 | 1593 | <span class="k">return</span> <span class="n">output</span></div> |
1555 | 1594 | </div> |
1556 | 1595 |
|
@@ -1586,7 +1625,7 @@ <h1>Source code for summarizedexperiment.base</h1><div class="highlight"><pre> |
1586 | 1625 |
|
1587 | 1626 | </aside> |
1588 | 1627 | </div> |
1589 | | -</div><script src="../../_static/documentation_options.js?v=73d9a94e"></script> |
| 1628 | +</div><script src="../../_static/documentation_options.js?v=d7a12d57"></script> |
1590 | 1629 | <script src="../../_static/doctools.js?v=9bcbadda"></script> |
1591 | 1630 | <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> |
1592 | 1631 | <script src="../../_static/scripts/furo.js?v=46bd48cc"></script> |
|
0 commit comments