GPSW documentation#

Version: 0.9.0

Description#

GPSW is a Python package for analysing Global Protein Stability Profiling data as described in Koren et al. Cell 2018 and Timms et al. Science 2019. It employs the Snakemake workflow management system to provide a reproducible and scalable analysis workflow.

Background

The background section provides an overview of the Global Protein Stability Profiling (GPS) method and the output of the GPSW workflow.

User guide

The user guide provides in-depth information on how to install and use GPSW.

About GPSW

Information about the GPSW project, its authors, and how to cite it.

Report issues

Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving GPSW.

Quick Start#

To install GPSW, you can use conda:

$ conda install -c bioconda gpsw

To download the workflow code:

$ gpsw fetch

Configure your analysis in config/config.yml, place your sequencing data in reads, and provide ORF metadata in a csv file in resources. Then run the workflow with:

$ gpsw run