Skip to content

Commit

Permalink
[FEATURE] Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
grosenberger committed May 28, 2019
1 parent 1868a56 commit ba5038f
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion README.md
@@ -1,3 +1,42 @@
EasyPQP: Simple library generation for OpenSWATH using MSFragger & PyProphet
EasyPQP: Simple library generation for OpenSWATH
================================================

EasyPQP is a Python package that provides simplified and fast peptide query parameter generation for OpenSWATH. It can process input from MSFragger or other database search engines in pepXML format. Statistical validation can be conducted either using PyProphet or PeptideProphet/iProphet. Retention times are calibrated using an internal or external standard. In addition to a cumulative library, run-specific libraries are generated for non-linear RT alignment in OpenSWATH.

Installation
============

We strongly advice to install EasyPQP in a Python [*virtualenv*](https://virtualenv.pypa.io/en/stable/). EasyPQP is compatible with Python 3.

Install the development version of *easypqp* from GitHub:

````
$ pip install git+https://github.com/grosenberger/easypqp.git@master
````

Running EasyPQP
===============

*EasyPQP* is not only a Python package, but also a command line tool:

````
$ easypqp --help
````

or:

````
$ easypqp convert --help
$ easypqp library --help
````

Docker
======

EasyPQP is also available from Docker (automated builds):

Pull the development version of *easypqp* from DockerHub (synced with GitHub):

````
$ docker pull grosenberger/easypqp:latest
````

0 comments on commit ba5038f

Please sign in to comment.