Skip to main content

PyMINEr: automated biologic insights from large datasets.

Project description

README

Tutorials

I've made some videos that walk you through the outputs as well as how to install and use PyMINEr here: www.ScienceScott.com/pyminer

What is this repository for?

  • cell type identification using novel clustering algorithms that outperform some competitors when applied to both real-world and synthetic datasets

  • basic statistics & enrichment analyses

  • pathway analyses

  • Spearman correlation-based expression graphs that enable analyses by graph theory

  • creation of in silico predicted autocrine/paracrine signaling networks within and across cell types

  • creation of publication-ready visuals based on these analyses

  • generation of a web page explaining the results of the run

  • Future releases will contain updated clustering methods that work for reconstructing single cell lineages, among other cool functions

How do I get set up?

PyMINEr is now pip installable: python3 -m pip install bio-pyminer Note that there was another package called pyminer for mining bit-coin - this is definitely not that, so be sure to install bio-pyminer instead!

You can also install using the setup.py script in the distribution like so: python3 setup.py install

How do I run PyMINEr?

PyMINEr takes as input a cleaned and normalized (typically log transformed) tab delimited 2D matrix text file. For example:

genes	cell_1	cell_2	...
ACTB   5.3012	 6.3102	...
...	...	...	...

You can feed this text file into PyMINEr in the command line:

pyminer.py -i expression.txt

If you have a really big file, you can convert it to hdf5 so that you can run the pipeline outside of memory:

tab_to_h5.py expression.txt

This will generate 3 files:

  • expression.hdf5
  • ID_list.txt the list of genes (no header line)
  • column_IDs.txt the sample names for the columns.

That's about it. There are some other interesting things you can do though, like if you are working with something that isn't human, you should be able to pass in the argument -species, followed by a species code that is taken by gProfiler. This will automate tons of pathway analyses, so long as the variables you're working with can be mapped over to Ensembl gene IDs by gProfiler. The default is homo sapiens (hsapiens).

A list of the gProfiler accepted species codes is listed here: https://biit.cs.ut.ee/gprofiler/page/organism-list

License

For non-commercial use, PyMINEr is available via the AGPLv3 license. Commercial entities should inquire with scottyler89@gmail.com

Who do I talk to?

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bio_pyminer-0.9.2.tar.gz (166.3 kB view hashes)

Uploaded Source

Built Distributions

bio_pyminer-0.9.2-py3.7.egg (549.9 kB view hashes)

Uploaded Source

bio_pyminer-0.9.2-py3-none-any.whl (362.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page