annotate README.rst @ 16:682041ae727d draft default tip

planemo upload commit 170560760f17fd1b77efe8bb95fedf3eb2433f0b-dirty
author proteore
date Thu, 22 Nov 2018 04:37:54 -0500
parents 9fe4a861601b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
1 Wrapper for Pathview tool
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
2 =============================
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
3
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
4 **Authors**
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
5
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
6 David Christiany, Florence Combes, Yves Vandenbrouck CEA, INSERM, CNRS, Grenoble-Alpes University, BIG Institute, FR
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
7
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
8 Sandra Dérozier, Olivier Rué, Christophe Caron, Valentin Loux INRA, Paris-Saclay University, MAIAGE Unit, Migale Bioinformatics platform
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
9
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
10 This work has been partially funded through the French National Agency for Research (ANR) IFB project.
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
11
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
12 Contact support@proteore.org for any questions or concerns about the Galaxy implementation of this tool.
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
13
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
14 =============================
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
15
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
16 This tool map a list of Uniprot Accession number or Entrez gene ID to KEGG pathway with pathview R package.
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
17
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
18 You can map Entrez gene IDs / Uniprot accession number from three species : human, mouse and rat.
8
33c9bd75882a planemo upload commit 1953798eb28b6e45c78342ed4c6a6a978d096fca
proteore
parents: 0
diff changeset
19
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
20 If your input have another type of IDs, please use the ID_Converter tool.
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
21
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
22 **Input:**
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
23
0
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
24
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
25 - KEGG Pathways IDs to be used for mapping can be set by:
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
26 - chosing from the KEGG pathways name list
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
27 - giving a list (copy/paste)
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
28 - importing a list from a dataset (column) - output of KEGG pathways identification and coverage can be used (1st column)
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
29 - Genes/proteins ids to map can be either a list of Entrez genes IDs / Uniprot accession number or a file (tabular, tsv, txt) containing at least one column of Entrez genes IDs / Uniprot accession number.
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
30 - fold change values (up to three columns) from a dataset (same dataset as for Genes/proteins ids to map)
8
33c9bd75882a planemo upload commit 1953798eb28b6e45c78342ed4c6a6a978d096fca
proteore
parents: 0
diff changeset
31
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
32 You can see below an example of an input file with identifiers (uniprot_AC) and fold_change values.
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
33
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
34 .. csv-table:: Simulated data
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
35 :header: "Uniprot_AC","Protein.name","Number_of_peptides","fc_values 1","fc_values 2","fc_values 3"
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
36
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
37 "P15924","Desmoplakin","69","0.172302292051025","-0.757435966487116","0.0411240398990759"
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
38 "P02538","Keratin, type II cytoskeletal 6A","53","-0.988842456122076","0.654626325100182","-0.219153396366064"
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
39 "P02768","Serum albumin","44","-0.983493243315454","0.113752002761474","-0.645886132600729"
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
40 "P08779","Keratin, type I cytoskeletal 16","29","0.552302597284443","-0.329045605110646","2.10616106806788"
0
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
41
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
42 |
0
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
43
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
44 **Output:**
0
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
45
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
46 - a **collection dataset** named 'KEGG pathways map from <dataset>', one file (png or pdf) for each given pathway.
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
47 - a **summary text file** (.tsv) of the mapping(s) with the following columns
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
48 - **KEGG pathway ID**: KEGG pathway(s) used to map given genes/proteins ids
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
49 - **pathway name**: name(s) of KEGG pathway(s) used for mapping
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
50 - **nb of Uniprot_AC used** (only when Uniprot accession number is given): number of Uniprot accession number which will be converted to Entrez genes IDs
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
51 - **nb of Entrez gene ID used**: number of Entrez gene IDs used for mapping
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
52 - **nb of Entrez gene ID mapped**: number of Entrez gene IDs mapped on a given pathway
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
53 - **nb of Entrez gene ID in the pathway**: number total of Entrez gene IDs in a given pathway
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
54 - **ratio of Entrez gene ID mapped**: number of Entrez gene IDs mapped / number total of Entrez gene IDs
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
55 - **Entrez gene ID mapped**: list of mapped Entrez gene IDs
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
56 - **uniprot_AC mapped** (only when Uniprot accession number is given): list of Uniprot accession number corresponding to the mapped Entrez gene IDs
0
097bb3ed2b4d planemo upload commit 2e441b4969ae7cf9aeb227a1d47c43ef7268a5e6-dirty
proteore
parents:
diff changeset
57
12
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
58 -----
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
59
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
60 .. class:: infomark
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
61
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
62 **Database:**
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
63
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
64 KEGG Pathways names list are from http://rest.kegg.jp/list/pathway/
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
65
9fe4a861601b planemo upload commit 7e2bd28d27e13c402acd46500f64d5c117797aa7-dirty
proteore
parents: 8
diff changeset
66 User manual / Documentation: http://www.bioconductor.org/packages/release/bioc/html/pathview.html