annotate README.txt @ 6:3941ba0da626

added license
author biomonika <biomonika@psu.edu>
date Fri, 20 Feb 2015 18:12:20 -0500
parents 939e59027486
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
1 **Fully automated pipeline for detection of sex linked genes using RNA-Seq data**
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
2
5
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
3 This pipeline has been designed for detection of sex-linked genes from the cross using RNASeq data.
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
4 It contains two workflows, one for detection of Y-linked and one for detection of X-linked genes.
0
05c27700e5ca initial commit
biomonika <biomonika@psu.edu>
parents:
diff changeset
5
4
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
6 INSTALLING PREREQUISITES
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
7 You will need 3 prerequisites in order to successfully run this pipeline:
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
8 1) install linkyx
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
9 2) install tool dependencies
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
10 3) import workflows
2
0d8315be76b7 Uploaded
biomonika
parents: 0
diff changeset
11
5
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
12 1) The easiest way how to install linkyx tools is to login to your local Galaxy instance and click
6
3941ba0da626 added license
biomonika <biomonika@psu.edu>
parents: 5
diff changeset
13 Admin -> Search and browse tool sheds -> Galaxy main tool shed -> linkyx
4
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
14
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
15 Click on the tool and then simply press button "Install to Galaxy" in the upper part of the screen.
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
16 This tool repository contains four tools:
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
17 LINKYX_X
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
18 Identify X linked contigs from cross
0
05c27700e5ca initial commit
biomonika <biomonika@psu.edu>
parents:
diff changeset
19
4
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
20 LINKYX_Y
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
21 Identify Y linked contigs from cross
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
22
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
23 LINKYX_mpileup
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
24 Run mpileup with LINKYX-specific parameters
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
25
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
26 Reformat Trinity header
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
27
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
28 All tools can be run independently, but the easiest way to obtain proper input files is via provided workflows.
2
0d8315be76b7 Uploaded
biomonika
parents: 0
diff changeset
29
5
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
30 2) The dependencies can be installed in a similar fashion as linkyx tool from the Galaxy tool shed by searching
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
31 for suite_linkyx_1_0
4
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
32
5
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
33 3) When installing linkyx from toolshed, you can click on the "Workflows" on the main page describing the tool
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
34 in the section "Contents of this repository". After clicking on either linkY or linkX, you will be presented an
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
35 option to install the workflows by clicking "Install to Galaxy" button.
0
05c27700e5ca initial commit
biomonika <biomonika@psu.edu>
parents:
diff changeset
36
4
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
37 RUNNING THE WORKFLOWS
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
38 After you imported workflows to the galaxy and installed linkyx and workflow dependencies, the pipeline is ready to go.
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
39
5
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
40 You can access it by clicking on the "Workflow" in the upper gray layer of your Galaxy instance. After clicking on the
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
41 name of the workflow and choosing "Run", you will be requested to select input datasets, two for each member of the cross
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
42 since paired-end reads are expected by default. If you don't have your data yet, test files are available in this repository.
939e59027486 edited README
biomonika <biomonika@psu.edu>
parents: 4
diff changeset
43 The computation for these files ends in ~5 minutes and outputs one X-linked and one Y-linked contig.
4
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
44
0979980b5bdc edited README file
biomonika <biomonika@psu.edu>
parents: 2
diff changeset
45 CONTACT INFORMATION
0
05c27700e5ca initial commit
biomonika <biomonika@psu.edu>
parents:
diff changeset
46 If you have any questions, please use following email address: biomonika@psu.edu