Skip to content

Commit 7b2ba8d

Browse files
committed
1 parent 0cf3ef7 commit 7b2ba8d

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

docs/dev/generated/skbio.io.format.lsmat.html

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
<head>
88
<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 (&lt;code..." />
911
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1012

1113
<title>Labeled square matrix format (skbio.io.format.lsmat) &#8212; scikit-bio 0.7.1-dev documentation</title>
@@ -763,15 +765,21 @@ <h2>Format Specification<a class="headerlink" href="#format-specification" title
763765
</section>
764766
<section id="format-parameters">
765767
<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
772774
length. This value is useful for reading a fixed-width text file. However, it
773775
cannot be automatically determined, nor can it be specified when writing to a
774776
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>
775783
</section>
776784
</section>
777785

docs/dev/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)