Skip to content

Commit c342ca2

Browse files
committed
1 parent 76e43c7 commit c342ca2

File tree

114 files changed

+145
-144
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+145
-144
lines changed

docs/dev/config.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -683,8 +683,8 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
683683
</table>
684684
</div>
685685
</section>
686-
<section id="configuraton-options">
687-
<h2>Configuraton options<a class="headerlink" href="#configuraton-options" title="Link to this heading">#</a></h2>
686+
<section id="id1">
687+
<h2>Configuration options<a class="headerlink" href="#id1" title="Link to this heading">#</a></h2>
688688
<p>At present, only one configuration option is available:</p>
689689
<dl>
690690
<dt><strong>table_output</strong><span class="classifier"><em>{“pandas”, “numpy”, “polars”}, default=”pandas”</em></span></dt><dd><p>The preferred output format of tables. See <a class="reference internal" href="table.html#table-output"><span class="std std-ref">details</span></a>.</p>
@@ -741,7 +741,7 @@ <h2>Configuraton options<a class="headerlink" href="#configuraton-options" title
741741
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
742742
<ul class="visible nav section-nav flex-column">
743743
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#functions">Functions</a></li>
744-
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#configuraton-options">Configuraton options</a></li>
744+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Configuration options</a></li>
745745
</ul>
746746
</nav></div>
747747

docs/dev/generated/skbio.alignment.TabularMSA.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1175,7 +1175,7 @@ <h1>skbio.alignment.TabularMSA<a class="headerlink" href="#skbio-alignment-tabul
11751175
</div>
11761176
<p>Here we sliced the first axis by a boolean vector, but then restricted
11771177
the columns to a single column. Because the second axis was given a
1178-
nonscalar we still recieve an MSA even though only one column is
1178+
nonscalar we still receive an MSA even though only one column is
11791179
present.</p>
11801180
</dd></dl>
11811181

@@ -1411,7 +1411,7 @@ <h1>skbio.alignment.TabularMSA<a class="headerlink" href="#skbio-alignment-tabul
14111411
</div>
14121412
<p>Here we sliced the first axis by a boolean vector, but then restricted
14131413
the columns to a single column. Because the second axis was given a
1414-
nonscalar we still recieve an MSA even though only one column is
1414+
nonscalar we still receive an MSA even though only one column is
14151415
present.</p>
14161416
<p>Duplicate labels can be an unfortunate reality in the real world,
14171417
however <cite>loc</cite> is capable of handling this:</p>

docs/dev/generated/skbio.alignment.global_pairwise_align.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -701,10 +701,10 @@ <h1>skbio.alignment.global_pairwise_align<a class="headerlink" href="#skbio-alig
701701
</dd>
702702
<dt><strong>seq2</strong><span class="classifier">GrammaredSequence or TabularMSA</span></dt><dd><p>The second unaligned sequence(s).</p>
703703
</dd>
704-
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for opening a gap (this is substracted from previous best
704+
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for opening a gap (this is subtracted from previous best
705705
alignment score, so is typically positive).</p>
706706
</dd>
707-
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for extending a gap (this is substracted from previous best
707+
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for extending a gap (this is subtracted from previous best
708708
alignment score, so is typically positive).</p>
709709
</dd>
710710
<dt><strong>substitution_matrix: 2D dict (or similar)</strong></dt><dd><p>Lookup for substitution scores (these values are added to the

docs/dev/generated/skbio.alignment.global_pairwise_align_nucleotide.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -701,10 +701,10 @@ <h1>skbio.alignment.global_pairwise_align_nucleotide<a class="headerlink" href="
701701
</dd>
702702
<dt><strong>seq2</strong><span class="classifier">DNA, RNA, or TabularMSA[DNA|RNA]</span></dt><dd><p>The second unaligned sequence(s).</p>
703703
</dd>
704-
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is substracted from previous best
704+
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is subtracted from previous best
705705
alignment score, so is typically positive).</p>
706706
</dd>
707-
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is substracted from previous best
707+
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is subtracted from previous best
708708
alignment score, so is typically positive).</p>
709709
</dd>
710710
<dt><strong>match_score</strong><span class="classifier">int or float, optional</span></dt><dd><p>The score to add for a match between a pair of bases (this is added

docs/dev/generated/skbio.alignment.global_pairwise_align_protein.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -701,10 +701,10 @@ <h1>skbio.alignment.global_pairwise_align_protein<a class="headerlink" href="#sk
701701
</dd>
702702
<dt><strong>seq2</strong><span class="classifier">Protein or TabularMSA[Protein]</span></dt><dd><p>The second unaligned sequence(s).</p>
703703
</dd>
704-
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is substracted from previous best
704+
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is subtracted from previous best
705705
alignment score, so is typically positive).</p>
706706
</dd>
707-
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is substracted from previous best
707+
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is subtracted from previous best
708708
alignment score, so is typically positive).</p>
709709
</dd>
710710
<dt><strong>substitution_matrix: 2D dict (or similar), optional</strong></dt><dd><p>Lookup for substitution scores (these values are added to the

docs/dev/generated/skbio.alignment.local_pairwise_align.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -701,10 +701,10 @@ <h1>skbio.alignment.local_pairwise_align<a class="headerlink" href="#skbio-align
701701
</dd>
702702
<dt><strong>seq2</strong><span class="classifier">GrammaredSequence</span></dt><dd><p>The second unaligned sequence.</p>
703703
</dd>
704-
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for opening a gap (this is substracted from previous best
704+
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for opening a gap (this is subtracted from previous best
705705
alignment score, so is typically positive).</p>
706706
</dd>
707-
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for extending a gap (this is substracted from previous best
707+
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float</span></dt><dd><p>Penalty for extending a gap (this is subtracted from previous best
708708
alignment score, so is typically positive).</p>
709709
</dd>
710710
<dt><strong>substitution_matrix: 2D dict (or similar)</strong></dt><dd><p>Lookup for substitution scores (these values are added to the

docs/dev/generated/skbio.alignment.local_pairwise_align_nucleotide.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -701,10 +701,10 @@ <h1>skbio.alignment.local_pairwise_align_nucleotide<a class="headerlink" href="#
701701
</dd>
702702
<dt><strong>seq2</strong><span class="classifier">DNA or RNA</span></dt><dd><p>The second unaligned sequence.</p>
703703
</dd>
704-
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is substracted from previous best
704+
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is subtracted from previous best
705705
alignment score, so is typically positive).</p>
706706
</dd>
707-
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is substracted from previous best
707+
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is subtracted from previous best
708708
alignment score, so is typically positive).</p>
709709
</dd>
710710
<dt><strong>match_score</strong><span class="classifier">int or float, optional</span></dt><dd><p>The score to add for a match between a pair of bases (this is added

docs/dev/generated/skbio.alignment.local_pairwise_align_protein.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -701,10 +701,10 @@ <h1>skbio.alignment.local_pairwise_align_protein<a class="headerlink" href="#skb
701701
</dd>
702702
<dt><strong>seq2</strong><span class="classifier">Protein</span></dt><dd><p>The second unaligned sequence.</p>
703703
</dd>
704-
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is substracted from previous best
704+
<dt><strong>gap_open_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for opening a gap (this is subtracted from previous best
705705
alignment score, so is typically positive).</p>
706706
</dd>
707-
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is substracted from previous best
707+
<dt><strong>gap_extend_penalty</strong><span class="classifier">int or float, optional</span></dt><dd><p>Penalty for extending a gap (this is subtracted from previous best
708708
alignment score, so is typically positive).</p>
709709
</dd>
710710
<dt><strong>substitution_matrix: 2D dict (or similar), optional</strong></dt><dd><p>Lookup for substitution scores (these values are added to the

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,7 @@ <h2>Feature Level Products<a class="headerlink" href="#feature-level-products" t
715715
ENA records, with each flatfile representing a single feature”</em>.
716716
While only the sequence of the feature is included in such entries, features
717717
are derived from the parent entry, and can’t be applied as interval metadata.
718-
For such reason, interval metatdata are ignored from Feature-level products,
718+
For such reason, interval metadata are ignored from Feature-level products,
719719
as they will be ignored by subsetting a generic Sequence object.</p>
720720
<section id="format-support">
721721
<h3>Format Support<a class="headerlink" href="#format-support" title="Link to this heading">#</a></h3>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,7 @@
712712
</pre></div>
713713
</div>
714714
<p>The QUAL file format is an additional format related to FASTA. A FASTA file is
715-
sometimes accompanied by a QUAL file, particuarly when the FASTA file contains
715+
sometimes accompanied by a QUAL file, particularly when the FASTA file contains
716716
sequences generated on a high-throughput sequencing instrument. QUAL files
717717
store a Phred quality score (nonnegative integer) for each base in a sequence
718718
stored in FASTA format (see <a class="reference internal" href="#rc6adbf0d8a87-4" id="id4">[4]</a> for more details). scikit-bio supports reading
@@ -802,7 +802,7 @@ <h4>Sequence Header<a class="headerlink" href="#sequence-header" title="Link to
802802
<p class="admonition-title">Note</p>
803803
<p>When reading a FASTA-formatted file, the sequence ID and description
804804
are stored in the sequence <cite>metadata</cite> attribute, under the <cite>‘id’</cite> and
805-
<cite>‘description’</cite> keys, repectively. Both are optional. Each will be
805+
<cite>‘description’</cite> keys, respectively. Both are optional. Each will be
806806
represented as the empty string (<code class="docutils literal notranslate"><span class="pre">''</span></code>) in <cite>metadata</cite> if it is not present
807807
in the header.</p>
808808
<p>When writing a FASTA-formatted file, sequence <cite>metadata</cite> identified by keys
@@ -881,7 +881,7 @@ <h3>QUAL Format<a class="headerlink" href="#qual-format" title="Link to this hea
881881
in the same order in both files (i.e., each FASTA and QUAL record must have
882882
the same ID and description after being parsed). In addition to having the
883883
same order, the number of FASTA records must match the number of QUAL
884-
records (i.e., missing or additonal records are not allowed). scikit-bio
884+
records (i.e., missing or additional records are not allowed). scikit-bio
885885
also requires that the number of quality scores match the number of bases in
886886
the corresponding sequence.</p>
887887
<p>When writing FASTA and QUAL files, scikit-bio will maintain the same

0 commit comments

Comments
 (0)