biodata - A standard biological data processing package
The biodata package provides a standard API to access different kinds of biological data using similar syntax. For each data type, data could be accessed in either stream- or index-based method. To obtain a stream of entries, data is processed by the reader (XX-Reader) and writer (XX-Writer). For example, FASTAReader is used to process a FASTA file. A call to the method read() from FASTAReader yields a FASTA object. To obtain entries from an indexed file, random access is supported through the XX-IReader. For example, an indexed FASTA file (with the associated .fai file) can be accessed by FASTAIReader to yield a FASTA object.
Installation
pip install biodata
Quick Start
For more advanced use, please see the Basic Usage section.
# Reading file contents
from biodata.fasta import FASTAReader
seq_dict = FASTAReader.read_all(lambda fr: {f.name:f.seq for f in fr}, "input.fa")
from biodata.bed import BEDReader
from genomictools import GenomicCollection
beds = BEDReader.read_all(GenomicCollection, "input.bed")
from biodata.gff import GFF3Reader
from genomictools import GenomicCollection
gff3s = GFF3Reader.read_all(GenomicCollection, "input.gff3")
from biodata.gff import GTFReader
from genomictools import GenomicCollection
gtfs = GTFReader.read_all(GenomicCollection, "input.gtf")
Basic usage
We will demonstrate the use of biodata package using FASTA file.
>seq1
ACGT
>seq2
CCCGGGAAA
Reading data
Read the first entry
from biodata.fasta import FASTAReader
with FASTAReader(filename) as fr:
f = fr.read()
print(f.name, f.seq) # seq1 ACGT
Read entry by entry
from biodata.fasta import FASTAReader
with FASTAReader(filename) as fr:
for f in fr:
print(f.name, f.seq)
# seq1 ACGT
# seq2 CCCGGGAAA
with BEDReader(bedfile) as br:
for b in br:
print(b.name, str(b.genomic_pos))
Read all entries at once
from biodata.fasta import FASTAReader
fasta_entries = FASTAReader.read_all(list, filename) # list of FASTA
seq_dict = FASTAReader.read_all(lambda fr: {f.name:f.seq for f in fr}, filename)
# A dictionary with fasta name as key and fasta sequence as value
# {"seq1": "ACGT", "seq2": "CCCGGGAAA"}
# For genomic range data, one could also use GenomicCollection to store them:
from biodata.bed import BEDReader
from genomictools import GenomicCollection
beds = BEDReader.read_all(GenomicCollection, filename)
Peek an entry
from biodata.fasta import FASTAReader
with FASTAReader(filename) as fr:
f = fr.peek() # Only peek the entry without proceeding to the next entry
print(f.name, f.seq) # seq1 ACGT
f = fr.read() # Read the entry and proceed to the next entry
print(f.name, f.seq) # seq1 ACGT
f = fr.read()
print(f.name, f.seq) # seq2 CCCGGGAAA
Read an entry from StringIO
# TextIOBase can be used as input instead of a file
import io
from biodata.fasta import FASTAReader
FASTAReader.read_all(list, io.StringIO(">seq1\nACGT\n>seq2\nCCCGGGAAA\n"))
Read an indexed file
from biodata.fasta import FASTAIReader
from genomictools import GenomicPos, StrandedGenomicPos
from biodata.bed import BED
fir = FASTAIReader(filename, faifilename) # fai file can be created using 'samtools faidx filename'
f = fir[GenomicPos("seq2:1-4")] # Read from a region without strand
print(f.name, f.seq) # seq2:1-4 CCCG
f = fir[StrandedGenomicPos("seq2:1-4:-")] # Read from a region with strand
print(f.name, f.seq) # seq2:1-4:- CGGG
f = fir[BED("seq2", 0, 4, strand="-")] # Equivalent to StrandedGenomicPos but a BED entry is used
print(f.name, f.seq) # seq2:1-4:- CGGG
fir.close()
Writing
Write entry by entry
from biodata.fasta import FASTA, FASTAWriter
with FASTAWriter(output_file) as fw:
fw.write(FASTA("seq1", "ACGT"))
fw.write(FASTA("seq2", "CCCGGGAAA"))
Write all entries at once
from biodata.fasta import FASTA, FASTAWriter
fasta_entries = [FASTA("seq1", "ACGT"), FASTA("seq2", "CCCGGGAAA")]
FASTAWriter.write_all(fasta_entries, output_file)
List of supported format
- Delimited - tsv, csv (
biodata.delimited) - FASTA, FASTQ (
biodata.fasta) - BED3, BED, BEDX, BEDGraph, BEDPE, BigBed, ENCODENarrowPeak (
biodata.bed) - GFF3, GTF (GFF2) (
biodata.gff) - BigWig (
biodata.bigwig, requirepyBigWigpackage) - bwa FastMap (
biodata.bwa.fastmap) - MEME Motif Format (
biodata.meme)
Future supported formats.
- VCF (
biodata.vcf)
Extension of BaseReader
Users can extend the BaseReader and BaseWriter class easily to accommodate other formats not currently supported by biodata.
class ExampleNode(object):
def __init__(self, value1, value2):
self.value1 = value1
self.value2 = value2
class ExampleNodeReader(BaseReader):
def __init__(self, filename):
super(ExampleNodeReader, self).__init__(filename)
def _read(self):
if self.line is None:
return None
words_array = self.line.split('\t')
value1 = words_array[0]
value2 = words_array[1]
self.proceed_next_line()
return ExampleNode(value1, value2)
filename = "SomeDocument.txt"
with ExampleNodeReader(filename) as er:
for node in er:
print(node.value1, node.value2)
Metadata
Release files for biodata 0.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| biodata-0.1.6.tar.gz | 20.6 kB | Without provenance | Details for biodata-0.1.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| biodata-0.1.6-py3-none-any.whl | Python 3 | none | any | Details for biodata-0.1.6-py3-none-any.whl |
Total release size: 43.8 kB
Release files / biodata-0.1.6.tar.gz
| Download URL | biodata-0.1.6.tar.gz |
|---|---|
| Size | 20.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
29025dc9d5b36e18260b80a677fe864275ba0913f7241ecd9bc6365adfabfea9
|
|
BLAKE2b-256 checksum How to use checksums |
77455ea9cc3c0786957428afa297101d1190a9c19899fa71ed1b66a35b21ac16
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.5
|
Release files / biodata-0.1.6-py3-none-any.whl
| Download URL | biodata-0.1.6-py3-none-any.whl |
|---|---|
| Size | 23.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b303c0976aa0b966df917d189afaa87c9e4bcf64f4fed2d2844d8e9bec68067d
|
|
BLAKE2b-256 checksum How to use checksums |
f3a7e0537ed1520b97be42d4bafb8a6fc1268484e6983e39743dd96f0d331a94
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.5
|
Security for biodata 0.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.