Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

The omicexperiment package is an open-source, BSD-licensed, Python 3 package for analysis of dataframes of ‘omic experiments’, built upon the solid foundations of the Python scientific stack.

The omicexperiment package has the goal of providing a pleasant API for rapid analysis of ‘omic experiments’ in interactive environments.

The R bioinformatics community has already provided similar implementations for similar functionality. Examples include DESeqDataSet (from the package DeSeq2), MRExperiment (from the package metagenomeSeq), phyloseq-class (from the package phyloseq). To my knowledge, there exists no similar powerful functionality available to users of python.

The philosophy of this package is to build upon solid foundations of the python scientific stack and try not to re-invent the wheel. Packages such as numpy and pandas are powerful optimized libraries in dealing with matrix and tabular data, respectively. This package’s backend thus consists almost entirely of pandas DataFrames and pandas APIs.

Example code

from omicexperiment.experiment.microbiome import MicrobiomeExperiment
from omicexperiment.filters import Sample, Taxonomy

mapping = "example_map.tsv"
biom = "example_fungal.biom"
tax = "blast_tax_assignments.txt"

#our Experiment object
exp = MicrobiomeExperiment(biom, mapping,tax)

#include only samples with more than 90000 counts
exp.filter(Sample.count > 90000)

##collapse the OTUs in the _data_ DataFrame to genus level assignment
exp.filter(Taxonomy.groupby('genus')) #any taxonomic rank can be passed

Installation

Just clone the git repository. Hopefully very shortly, the package will be uploaded to PyPi and will be pip-installable.

Due to bugs in handling numpy installation in setuptools, it is better to install numpy first using ‘pip install numpy’.

Dependencies

Current omicexperiment dependencies:

  • numpy

  • scipy

  • pandas

  • scikit-bio

  • biom-format

  • lxml

  • pygal

License

This package is released as open-source, under a BSD License. Please see COPYING.txt.

Documentation

Please see the doc folder in the package (https://github.com/bassio/omicexperiment/tree/master/doc), it contains Jupyter notebooks that runs you through most of the current package functionality.

Acknowledgements

Thank you to all the great python bioinformatics and data science community for releasing their code as open source.

Contributing and use in your research

Please be advised that at this stage, this package is still alpha software. Testing is still not implemented so be careful. But if you are interested in contributing to this project, please contact. Contributors are welcome to improve the software. Nowadays, I expect the package to continue growing slowly as I add functionality and improvements as long as I need it in my own research. I will be initially focusing on developing the MicrobiomeExperiment part.

0.1.2-dev

  • Development version(s) dedicated to fixing PyPI installation.

0.1.1

  • Initial version

Metadata

Release files for omicexperiment 0.1.2.dev1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for omicexperiment 0.1.2.dev1
File Size Uploaded
omicexperiment-0.1.2.dev1.tar.gz 106.4 kB Details

Release files / omicexperiment-0.1.2.dev1.tar.gz

Download URL omicexperiment-0.1.2.dev1.tar.gz
Size 106.4 kB
Tags Source
SHA-256 checksum
How to use checksums
32f22bea52598f05a449f9cf333dac8c7cd890ad20164c8012df6d8b44acfe27
BLAKE2b-256 checksum
How to use checksums
21a76ea7bf33b7a7fc06758fab5ba17fc1626fc4f4e5e77d75c61ceb7a39a33a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.2.dev1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page