|
6 | 6 |
|
7 | 7 | <head> |
8 | 8 | <meta charset="utf-8" /> |
| 9 | + <meta name="description" content="A string used to separate elements in the file format. Can be specified when |
| 10 | +reading from or writing to a file. Default is the tab character (<code..." /> |
9 | 11 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
10 | 12 |
|
11 | 13 | <title>Labeled square matrix format (skbio.io.format.lsmat) — scikit-bio 0.7.1-dev documentation</title> |
@@ -763,15 +765,21 @@ <h2>Format Specification<a class="headerlink" href="#format-specification" title |
763 | 765 | </section> |
764 | 766 | <section id="format-parameters"> |
765 | 767 | <h2>Format Parameters<a class="headerlink" href="#format-parameters" title="Link to this heading">#</a></h2> |
766 | | -<p>The only supported format parameter is <code class="docutils literal notranslate"><span class="pre">delimiter</span></code>, which defaults to the tab |
767 | | -character (<code class="docutils literal notranslate"><span class="pre">'\t'</span></code>). <code class="docutils literal notranslate"><span class="pre">delimiter</span></code> is used to separate elements in the file |
768 | | -format. Examples include tab (<code class="docutils literal notranslate"><span class="pre">'\t'</span></code>) for TSV format and comma (<code class="docutils literal notranslate"><span class="pre">','</span></code>) for |
769 | | -CSV format. <code class="docutils literal notranslate"><span class="pre">delimiter</span></code> can be specified as a keyword argument when reading |
770 | | -from or writing to a file.</p> |
771 | | -<p>A special <code class="docutils literal notranslate"><span class="pre">delimiter</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, which represents a whitespace of arbitrary |
| 768 | +<dl class="simple"> |
| 769 | +<dt>delimiter<span class="classifier">str, optional</span></dt><dd><p>A string used to separate elements in the file format. Can be specified when |
| 770 | +reading from or writing to a file. Default is the tab character (<code class="docutils literal notranslate"><span class="pre">'\t'</span></code>), and |
| 771 | +the format is usually referred to as tab-separated values (TSV). Another common |
| 772 | +choice is comma (<code class="docutils literal notranslate"><span class="pre">','</span></code>), used in the comma-separated values (CSV) format. A |
| 773 | +special <code class="docutils literal notranslate"><span class="pre">delimiter</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, which represents a whitespace of arbitrary |
772 | 774 | length. This value is useful for reading a fixed-width text file. However, it |
773 | 775 | cannot be automatically determined, nor can it be specified when writing to a |
774 | 776 | file.</p> |
| 777 | +</dd> |
| 778 | +<dt>dtype<span class="classifier">str or dtype, optional</span></dt><dd><p>The data type of the underlying matrix data. Only relevant when reading from a |
| 779 | +file. Default is “float64”, which maps to <code class="docutils literal notranslate"><span class="pre">np.float64</span></code>. The only other available |
| 780 | +option is “float32” (or <code class="docutils literal notranslate"><span class="pre">np.float32</span></code>).</p> |
| 781 | +</dd> |
| 782 | +</dl> |
775 | 783 | </section> |
776 | 784 | </section> |
777 | 785 |
|
|
0 commit comments