ShiuLab / PseudogenePipeline

Creative Commons Zero v1.0 Universal
36 stars 18 forks source link

Pseudogene pipeline

Scripts and wrapper file for runing the Shiu Lab's pseduogene pipeline.

Overview

Associated publications

Requirements

Useage

Cut-to-the-chase

The pipline is run using:

python _scripts/PseudogenePipeline.py [parameter_file]

To invoke the help function, run:

python _scripts/PseudogenePipeline.py

About the parameter file

This text file specifies how the pipeline should run and an example can found in in the _example_files folder.

Test run

Two test datasets are provided for you to gauge whether there is any issues.

  1. _test25.tgz: This compressed file contains a test dataset of 25 proteins that takes ~1 minute to run. To use:
tar xvzf _test25.tgz
cd _test25

Then make sure the test_parameter_file in the folder is modified to specifiy:

Below we assume that you are in the _test25 folder is in the cloned PseudogenePipeline folder. Run the pipeline:

python ../_scripts/PseudogenePipeline.py test_parameter_file 

The _expected_results folder contains what you should be seeing.

  1. _test27206.tgz: This is a test case that is more realistic with a larger Arabidopsis thaliana dataset that takes ~20-30 min to run.

Ouput

The output of the pipeline is seperated into the following subfolder:

Versio info

v.2.0.0

v1.0.0