Skip to content

Commit fb63e5c

Browse files
LCrossmanLCrossman
committed
tidying format
1 parent 47dbd2d commit fb63e5c

9 files changed

Lines changed: 211 additions & 25 deletions

File tree

‎docs/microbiorust-py.md‎

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,48 @@ for r in result:
1818

1919
microbiorust-py contains the following features:
2020

21-
GenBank input:
21+
GenBank input:
22+
2223
gbk_to_faa # converts gbk format to protein fasta
23-
gbk_to_fna # converts gbk format to DNA sequence contigs fasta
24-
gbk_to_ffn # converts gbk format to DNA gene sequence fasta
25-
gbk_to_gff # converts gbk format to GFF3
26-
gbk_to_faa_count # counts numbers of protein fasta converted from gbk
24+
25+
gbk_to_fna # converts gbk format to DNA sequence contigs fasta
26+
27+
gbk_to_ffn # converts gbk format to DNA gene sequence fasta
28+
29+
gbk_to_gff # converts gbk format to GFF3
30+
31+
gbk_to_faa_count # counts numbers of protein fasta converted from gbk
2732

2833
EMBL input:
29-
embl_to_faa
30-
embl_to_fna
31-
embl_to_gff
3234

33-
BLAST input:
35+
embl_to_faa
36+
37+
embl_to_fna
38+
39+
embl_to_gff
40+
41+
42+
BLAST input:
43+
3444
parse_tabular # streaming parse BLAST input as -outfmt 6
35-
parse_XML # streaming BLAST parser for -outfmt 5
3645

37-
Alignment input (MSA):
38-
subset_msa_alignment # subset the alignment by row and column
39-
get_consensus # get a consensus sequence for your MSA alignment
46+
parse_XML # streaming BLAST parser for -outfmt 5
47+
48+
49+
Alignment input (MSA):
50+
51+
subset_msa_alignment # subset the alignment by row and column
52+
53+
get_consensus # get a consensus sequence for your MSA alignment
54+
55+
56+
Calculate sequence metrics:
57+
58+
hydrophobicity
59+
60+
amino_counts # counts of each amino acid in the provided sequence
61+
62+
amino_percentage # percentage of each amino acid in the provided sequence
4063

41-
Calculate sequence metrics:
42-
hydrophobicity
43-
amino_counts # counts of each amino acid in the provided sequence
44-
amino_percentage # percentage of each amino acid in the provided sequence
4564

4665

‎site/404.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,28 @@
326326

327327

328328

329+
330+
331+
332+
333+
334+
335+
<li class="md-nav__item">
336+
<a href="/microBioRust/microbiorust-py/" class="md-nav__link">
337+
338+
339+
340+
<span class="md-ellipsis">
341+
Python - microbiorust-py
342+
343+
</span>
344+
345+
346+
</a>
347+
</li>
348+
349+
350+
329351
</ul>
330352
</nav>
331353
</div>

‎site/formats_and_parsing/index.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
<link rel="prev" href="../usage/">
1515

1616

17+
<link rel="next" href="../microbiorust-py/">
18+
1719

1820
<link rel="icon" href="../assets/images/favicon.png">
1921
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.15">
@@ -338,6 +340,28 @@
338340

339341

340342

343+
344+
345+
346+
347+
348+
349+
<li class="md-nav__item">
350+
<a href="../microbiorust-py/" class="md-nav__link">
351+
352+
353+
354+
<span class="md-ellipsis">
355+
Python - microbiorust-py
356+
357+
</span>
358+
359+
360+
</a>
361+
</li>
362+
363+
364+
341365
</ul>
342366
</nav>
343367
</div>

‎site/index.html‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@
302302
<li class="md-nav__item">
303303
<a href="#interested-in-microbiorust-py-check-out-the-microbiorust-py-section-for-quick-start-more" class="md-nav__link">
304304
<span class="md-ellipsis">
305-
Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start &amp; more!
305+
Interested in microbiorust-py? Check out the microbiorust-py section for quick-start &amp; more!
306306
</span>
307307
</a>
308308

@@ -404,6 +404,28 @@
404404

405405

406406

407+
408+
409+
410+
411+
412+
413+
<li class="md-nav__item">
414+
<a href="microbiorust-py/" class="md-nav__link">
415+
416+
417+
418+
<span class="md-ellipsis">
419+
Python - microbiorust-py
420+
421+
</span>
422+
423+
424+
</a>
425+
</li>
426+
427+
428+
407429
</ul>
408430
</nav>
409431
</div>
@@ -451,7 +473,7 @@
451473
<li class="md-nav__item">
452474
<a href="#interested-in-microbiorust-py-check-out-the-microbiorust-py-section-for-quick-start-more" class="md-nav__link">
453475
<span class="md-ellipsis">
454-
Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start &amp; more!
476+
Interested in microbiorust-py? Check out the microbiorust-py section for quick-start &amp; more!
455477
</span>
456478
</a>
457479

@@ -485,8 +507,9 @@ <h2 id="features">Features</h2>
485507
<hr />
486508
<h2 id="get-started">Get Started!!</h2>
487509
<p>See Installation for details on how to install Rust for Linux, MacOSX and Windows</p>
488-
<h2 id="interested-in-microbiorust-py-check-out-the-microbiorust-py-section-for-quick-start-more">Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start &amp; more!</h2>
489-
<p>for microbiorust-py install with pip, no need to install Rust - see the microbiorust-py section</p>
510+
<p>If you want to call microbiorust from Python, that is microbiorust-py:</p>
511+
<h2 id="interested-in-microbiorust-py-check-out-the-microbiorust-py-section-for-quick-start-more">Interested in microbiorust-py? Check out the microbiorust-py section for quick-start &amp; more!</h2>
512+
<p>for <code>microbiorust-py</code> install with pip, no need to install Rust - see the microbiorust-py section</p>
490513
<p>Start a new project
491514
<code>cargo new microBioRust_test</code></p>
492515
<p>Add to your Cargo.toml

‎site/installation/index.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,28 @@
340340

341341

342342

343+
344+
345+
346+
347+
348+
349+
<li class="md-nav__item">
350+
<a href="../microbiorust-py/" class="md-nav__link">
351+
352+
353+
354+
<span class="md-ellipsis">
355+
Python - microbiorust-py
356+
357+
</span>
358+
359+
360+
</a>
361+
</li>
362+
363+
364+
343365
</ul>
344366
</nav>
345367
</div>

‎site/microbiorust-py/index.html‎

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,16 @@
1111
<link rel="canonical" href="https://lcrossman.github.io/microBioRust/microbiorust-py/">
1212

1313

14+
<link rel="prev" href="../formats_and_parsing/">
15+
1416

1517

1618
<link rel="icon" href="../assets/images/favicon.png">
1719
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.15">
1820

1921

2022

21-
<title>Microbiorust py - microBioRust docs</title>
23+
<title>Python - microbiorust-py - microBioRust docs</title>
2224

2325

2426

@@ -103,7 +105,7 @@
103105
<div class="md-header__topic" data-md-component="header-topic">
104106
<span class="md-ellipsis">
105107

106-
Microbiorust py
108+
Python - microbiorust-py
107109

108110
</span>
109111
</div>
@@ -328,6 +330,36 @@
328330

329331

330332

333+
334+
335+
336+
337+
338+
339+
340+
341+
<li class="md-nav__item md-nav__item--active">
342+
343+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
344+
345+
346+
347+
<a href="./" class="md-nav__link md-nav__link--active">
348+
349+
350+
351+
<span class="md-ellipsis">
352+
Python - microbiorust-py
353+
354+
</span>
355+
356+
357+
</a>
358+
359+
</li>
360+
361+
362+
331363
</ul>
332364
</nav>
333365
</div>
@@ -360,7 +392,7 @@
360392

361393

362394

363-
<h1>Microbiorust py</h1>
395+
<h1>Python - microbiorust-py</h1>
364396

365397
<p>For ease of use you can call directly from <em>Python</em> </p>
366398
<p>No need to install Rust </p>

‎site/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎site/usage/index.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,28 @@
340340

341341

342342

343+
344+
345+
346+
347+
348+
349+
<li class="md-nav__item">
350+
<a href="../microbiorust-py/" class="md-nav__link">
351+
352+
353+
354+
<span class="md-ellipsis">
355+
Python - microbiorust-py
356+
357+
</span>
358+
359+
360+
</a>
361+
</li>
362+
363+
364+
343365
</ul>
344366
</nav>
345367
</div>

‎site/windows_install/index.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,28 @@
347347

348348

349349

350+
351+
352+
353+
354+
355+
356+
<li class="md-nav__item">
357+
<a href="../microbiorust-py/" class="md-nav__link">
358+
359+
360+
361+
<span class="md-ellipsis">
362+
Python - microbiorust-py
363+
364+
</span>
365+
366+
367+
</a>
368+
</li>
369+
370+
371+
350372
</ul>
351373
</nav>
352374
</div>

0 commit comments

Comments
 (0)