Skip to content

Commit e4cea1f

Browse files
committed
adding details on microbiorust-py
1 parent a01e294 commit e4cea1f

Some content is hidden

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

65 files changed

+10605
-3
lines changed

.DS_Store

6 KB
Binary file not shown.

docs/.DS_Store

6 KB
Binary file not shown.

docs/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Welcome to micro**BioRust**
22

3-
A blazing-fast, sustainable bioinformatics toolkit written in [Rust](https://www.rust-lang.org/) — for microbial genomics rresearch, and optimised for functions used in data exploration.
3+
A blazing-fast, sustainable bioinformatics toolkit written in [Rust](https://www.rust-lang.org/) — for microbial genomics research, and optimised for functions used in data exploration.
44

55
---
66

@@ -14,7 +14,10 @@ A blazing-fast, sustainable bioinformatics toolkit written in [Rust](https://www
1414

1515
## Get Started!!
1616
See Installation for details on how to install Rust for Linux, MacOSX and Windows
17-
Interested in microbiorust-py? Check out the microbiorust-py section for quick-start & more!
17+
18+
##Interested in microbiorust-py?## Check out the microbiorust-py section for quick-start & more!
19+
20+
for microbiorust-py install with pip, no need to install Rust - see the microbiorust-py section
1821

1922
Start a new project
2023
```cargo new microBioRust_test```
@@ -29,7 +32,7 @@ to add the whole workspace including file parsing, sequence metrics, coming soon
2932
```cargo add -p microbiorust-py```
3033

3134
or clone the repo
32-
```git clone https://github.com/LCrossman/microBioRust.git```
35+
```git clone https://github.com/microBioRust/microBioRust.git```
3336

3437
Build the project
3538
```cargo build```

docs/microbiorust-py.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
For ease of use you can call directly from *Python*
3+
4+
No need to install Rust
5+
6+
Install microbiorust-py using pip:
7+
8+
```pip install microbiorust```
9+
10+
example script for converting from GenBank to protein fasta:
11+
12+
```
13+
from microbiorust import gbk_to_faa
14+
result = gbk_to_faa("filename.gbk")
15+
for r in result:
16+
print(r)
17+
```
18+
19+
microbiorust-py contains the following features:
20+
21+
GenBank input:
22+
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
27+
28+
EMBL input:
29+
embl_to_faa
30+
embl_to_fna
31+
embl_to_gff
32+
33+
BLAST input:
34+
parse_tabular # streaming parse BLAST input as -outfmt 6
35+
parse_XML # streaming BLAST parser for -outfmt 5
36+
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
40+
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
45+
46+

0 commit comments

Comments
 (0)