Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
ppx
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

A Python interface to proteomics data repositories

conda PyPI testsDocumentation Status

Overview

ppx provides a simple, programmatic means to access proteomics data that are publicly available in ProteomeXchange partner repositories. ppx allows users to easily find and download files associated with projects in PRIDE and MassIVE. In doing so, ppx promotes the reproducible analysis of proteomics data.

For full documentation and examples, visit: https://ppx.readthedocs.io

Installation

ppx requires Python 3.6+ and depends upon the requests and tqdm Python packages. ppx and any missing dependencies are easily installed with pip or with conda through the bioconda channel.

Install with conda:

conda install -c bioconda ppx

Or install with pip:

pip3 install ppx

Configuration

By default, ppx will download project files in the .ppx directory under the current user's home directory (~/.ppx on Linux and MacOS). There are several ways to specify different data directories:

  1. Change the ppx data directory for all future Python sessions by setting the PPX_DATA_DIR environment variable to your preferred directory.

  2. Change the ppx data directory for a Python session using the ppx.set_data_dir() function.

  3. Specify a data directory for a project using the local argument:

>>> import ppx

>>> proj = ppx.find_project("PXD000001", local="my/data/dir")

Why does ppx set a default data directory? We found that this makes it easier to reuse the same proteomics data files in multiple tasks that we're working on.

Examples

First, find a project using its ProteomeXchange or MassIVE identifier:

>>> import ppx

>>> proj = ppx.find_project("PXD000001")

We can then view the files associated with the project in the repository (PRIDE in this case):

>>> proj.remote_files()
#['F063721.dat',
# 'F063721.dat-mztab.txt',
# 'PRIDE_Exp_Complete_Ac_22134.xml.gz',
# 'PRIDE_Exp_mzData_Ac_22134.xml.gz',
# 'PXD000001_mztab.txt',
# 'README.txt',
# 'TMT_Erwinia_1uLSike_Top10HCD_isol2_45stepped_60min_01-20141210.mzML',
# 'TMT_Erwinia_1uLSike_Top10HCD_isol2_45stepped_60min_01-20141210.mzXML',
# 'TMT_Erwinia_1uLSike_Top10HCD_isol2_45stepped_60min_01.mzXML',
# 'TMT_Erwinia_1uLSike_Top10HCD_isol2_45stepped_60min_01.raw',
# 'erwinia_carotovora.fasta',
# 'generated/PRIDE_Exp_Complete_Ac_22134.pride.mgf.gz',
# 'generated/PRIDE_Exp_Complete_Ac_22134.pride.mztab.gz']

We can also glob for specific types of files:

>>> proj.remote_files("*.mzML")
# ['TMT_Erwinia_1uLSike_Top10HCD_isol2_45stepped_60min_01-20141210.mzML']

Then we can download one or more files to the projects local data directory:

>>> proj.download("README.txt")
# [PosixPath('/Users/wfondrie/.ppx/PXD000001/README.txt')]

Once we've downloaded files, ppx no longer needs an internet connection to retrieve a project's local data. However, you will need to specify the repository in which the project data resides. If we start a new Python session, we can find our previous file easily:

>>> import ppx

>>> proj = ppx.find_project("PXD000001", repo="PRIDE")
>>> proj.local_files()
# [PosixPath('/Users/wfondrie/.ppx/PXD000001/README.txt')]

If you are an R user...

ppx was inspired the rpx R package by Laurent Gatto. Check it out on Bioconductor and GitHub.

About

A Python interface to the ProteomeXchange Repository

Resources

License

Packages

No packages published

Languages