diff sort_by_tissue.xml @ 0:3155d867c056 draft default tip

planemo upload
author lnguyen
date Fri, 15 Sep 2017 11:04:37 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sort_by_tissue.xml	Fri Sep 15 11:04:37 2017 -0400
@@ -0,0 +1,229 @@
+<tool id="biofilter" name="Sort your proteins by tissue expression profiles (From HPA)" version="0.1.0">
+    <description>selects/discards proteins according to their expression profiles (absence/presence) in a list of tissues/organs)
+    </description>
+    <requirements>
+    </requirements>
+    <stdio>
+        <exit_code range="1:" />
+    </stdio>
+    <command><![CDATA[
+        python $__tool_directory__/sort_by_tissue.py 
+        --input
+        #if $input.ids == "text"
+            "$input.txt" "list"
+        #else if $input.ids == "file"
+            "$input.file" "file" "$input.header" "$input.ncol" 
+	    #end if
+        --hpa "$__tool_directory__/normal_tissue.csv"
+        -o "$hpa_output"
+        --tissues_del "$opt_del.tdel"
+        --trash "$trash_output"
+        --trash_file_detail "$trash_detail_output"
+        --na_file "$na_file"
+        #if $opt_keep.tkeep:
+            --tissues_keep "$opt_keep.tkeep"
+        #end if
+    ]]></command>
+    <inputs>
+        <conditional name="input" >
+            <param name="ids" type="select" label="Please provide your ENSG identifiers" help="Copy/paste or ID list from a file (e.g. table)" >
+                <option value="text">Copy/paste your identifiers</option>
+                <option value="file">Input file containing your identifiers</option>
+            </param>
+            <when value="text" >
+                <param name="txt" type="text" label="Copy/paste your identifiers" help='IDs must be separated by spaces into the form field, for example: P31946 P62258' >
+                    <sanitizer>
+                        <valid initial="string.printable">
+                            <remove value="&apos;"/>
+                        </valid>
+                        <mapping initial="none">
+                            <add source="&apos;" target="__sq__"/>
+                        </mapping>
+                    </sanitizer>
+                </param>
+            </when>
+            <when value="file" >
+                <param name="file" type="data" format="txt,tabular" label="Choose a file that contains your list of IDs" help="" />
+                <param name="header" type="boolean" checked="true" truevalue="true" falsevalue="false" label="Does your input file contain header?" />
+                <param name="ncol" type="text" label="The column number of ENSG IDs" help='For example, fill in "c1" if it is the first column, "c2" if it is the second column and so on' />                
+            </when>
+        </conditional>
+        <section name="opt_del" title="Step 1: Eliminate from my list genes expressed in the following tissue(s)" expanded="True">
+            <param name="tdel" type="select" label="Eliminate from my list genes expressed in the following tissue(s)" multiple="True" display="checkboxes">
+                <option value="adrenal gland" >Adrenal gland</option>
+                <option value="appendix" >Appendix</option>
+                <option value="bone marrow" >Bone marrow</option>
+                <option value="breast" >Breast</option>
+                <option value="bronchus" >Bronchus</option>
+                <option value="caudate" >Caudate</option>
+                <option value="cerebellum" >Cerebellum</option>
+                <option value="cerebral cortex" >Cerebral cortex</option>
+                <option value="cervix" >Cervix</option>
+                <option value="colon" >Colon</option>
+                <option value="duodenum" >Duodenum</option>
+                <option value="endometrium 1" >Endometrium 1</option>
+                <option value="endometrium 2" >Endometrium 2</option>
+                <option value="epididymis" >Epididymis</option>
+                <option value="esophagus" >Esophagus</option>
+                
+                <option value="fallopian tube" >Fallopian tube</option>
+                <option value="gallbladder" >Gallbladder</option>
+                
+                <option value="heart muscle" >Heart muscle</option>
+                <option value="hippocampus" >Hippocampus</option>
+                
+                <option value="kidney" >Kidney</option>
+            
+                <option value="liver" >Liver</option>
+                <option value="lung" >Lung</option>
+                <option value="lymph node" >Lymph node</option>
+                <option value="nasopharynx" >Nasopharynx</option>
+                <option value="oral mucosa" >Oral mucosa</option>
+                <option value="ovary" >Ovary</option>
+                <option value="pancreas" >Pancreas</option>
+                <option value="parathyroid gland" >Parathyroid gland</option>
+                
+                <option value="placenta" >Placenta</option>
+                <option value="prostate" >Prostate</option>
+                <option value="rectum" >Rectum</option>
+            
+                <option value="salivary gland" >Salivary gland</option>
+                <option value="seminal vesicle" >Seminal vesicle</option>
+                <option value="skeletal muscle" >Skeletal muscle</option>
+                <option value="skin 1" >Skin 1</option>
+                <option value="skin 2" >Skin 2</option>
+                
+                <option value="small intestine" >Small intestine</option>
+                <option value="smooth muscle" >Smooth muscle</option>
+                <option value="soft tissue 1" >Soft tissue 1</option>
+                <option value="soft tissue 2" >Soft tissue 2</option>
+                <option value="spleen" >Spleen</option>
+                <option value="stomach 1" >Stomach 1</option>
+                <option value="stomach 2" >Stomach 2</option>
+                <option value="testis" >Testis</option>
+                <option value="thyroid gland" >Thyroid gland</option>
+                <option value="tonsil" >Tonsil</option>
+                <option value="urinary bladder" >Urinary bladder</option>
+                <option value="vagina" >Vagina</option>
+            </param>
+        </section>
+        <section name="opt_keep" title="Step 2 (optional): Choose tissues where expressed genes need to be kept even if expressed in list of tissues in step 1" expanded="False">
+            <param name="tkeep" type="select" label="Choose tissues where expressed genes need to be kept even if expressed in list of tissues in step 1" multiple="True" optional="True" display="checkboxes" >
+                <option value="adrenal gland" >Adrenal gland</option>
+                <option value="appendix" >Appendix</option>
+                <option value="bone marrow" >Bone marrow</option>
+                <option value="breast" >Breast</option>
+                <option value="bronchus" >Bronchus</option>
+                <option value="caudate" >Caudate</option>
+                <option value="cerebellum" >Cerebellum</option>
+                <option value="cerebral cortex" >Cerebral cortex</option>
+                <option value="cervix" >Cervix</option>
+                <option value="colon" >Colon</option>
+                <option value="duodenum" >Duodenum</option>
+                <option value="endometrium 1" >Endometrium 1</option>
+                <option value="endometrium 2" >Endometrium 2</option>
+                <option value="epididymis" >Epididymis</option>
+                <option value="esophagus" >Esophagus</option>
+                
+                <option value="fallopian tube" >Fallopian tube</option>
+                <option value="gallbladder" >Gallbladder</option>
+                
+                <option value="heart muscle" >Heart muscle</option>
+                <option value="hippocampus" >Hippocampus</option>
+            
+                <option value="kidney" >Kidney</option>
+       
+                <option value="liver" >Liver</option>
+                <option value="lung" >Lung</option>
+                <option value="lymph node" >Lymph node</option>
+                <option value="nasopharynx" >Nasopharynx</option>
+                <option value="oral mucosa" >Oral mucosa</option>
+                <option value="ovary" >Ovary</option>
+                <option value="pancreas" >Pancreas</option>
+                <option value="parathyroid gland" >Parathyroid gland</option>
+                
+                <option value="placenta" >Placenta</option>
+                <option value="prostate" >Prostate</option>
+                <option value="rectum" >Rectum</option>
+            
+                <option value="salivary gland" >Salivary gland</option>
+                <option value="seminal vesicle" >Seminal vesicle</option>
+                <option value="skeletal muscle" >Skeletal muscle</option>
+                <option value="skin 1" >Skin 1</option>
+                <option value="skin 2" >Skin 2</option>
+            
+                <option value="small intestine" >Small intestine</option>
+                <option value="smooth muscle" >Smooth muscle</option>
+                <option value="soft tissue 1" >Soft tissue 1</option>
+                <option value="soft tissue 2" >Soft tissue 2</option>
+                <option value="spleen" >Spleen</option>
+                <option value="stomach 1" >Stomach 1</option>
+                <option value="stomach 2" >Stomach 2</option>
+                <option value="testis" >Testis</option>
+                <option value="thyroid gland" >Thyroid gland</option>
+                <option value="tonsil" >Tonsil</option>
+                <option value="urinary bladder" >Urinary bladder</option>
+                <option value="vagina" >Vagina</option>
+            </param>
+        </section>
+    </inputs>
+    <outputs>
+        <data name="hpa_output" format="tabular" label="HPA selection" />
+        <data name="trash_detail_output" format="tabular" label="HPA information of excluded genes" />
+        <data name="trash_output" format="tabular" label="Excluded genes ID" />
+        <data name="na_file" format="tabular" label="Genes without tissues information" />
+    </outputs>
+    <tests>
+        <test>
+            <conditional name="input">
+                <param name="ids" value="file" />
+                <param name="file" value="IDs.txt" />
+                <param name="header" value="true" />
+                <param name="ncol" value="c3" />
+            </conditional>
+            <section name="opt_del">
+                <param name="tdel" value="salivary gland" />
+            </section>
+            <section name="opt_keep">
+                <param name="tkeep" value="lung" />
+            </section>
+            <output name="hpa_output" file="sort_by_tissue_output.txt" />
+            <output name="trash_detail_output" file="trash_detail_sort_by_tissue.txt" />
+            <output name="trash_output" file="trash_sort_by_tissue.txt" />
+            <output name="na_file" file="na_sort_by_tissue.txt" />
+        </test>
+    </tests>
+    <help><![CDATA[
+This tool filters the proteins according to their tissue(s) of origin using Human Protein Atlas (http://www.proteinatlas.org/).
+
+**Input**
+
+This tool requires a list of ENSG IDs, by copy/paste into text field or choose from a file.
+
+**Option**
+
+Firstly, you can choose tissues in which genes expressed need to be eliminated. If among these eliminated genes, you want to keep genes expressed in some other tissues, you can choose these tissues in the second list.
+
+For example, when you want to eliminate from input file the genes that are expressed in salivary, but among these genes, you want to keep the genes that are also expressed in lung:
+
+* Step 1: choose salivary gland
+
+* Step 2: choose lung
+
+-----
+
+.. class:: infomark
+
+**Authors**
+
+T.P. Lien Nguyen, Florence Combes, Yves Vandenbrouck CEA, INSERM, CNRS, Grenoble-Alpes University, BIG Institute, FR
+Sandra Dérozier, Olivier Rué, Christophe Caron, Valentin Loux INRA, Paris-Saclay University, MAIAGE Unit, Migale Bioinformatics platform
+
+This work has been partially funded through the French National Agency for Research (ANR) IFB project.
+
+Contact support@proteore.org for any questions or concerns about the Galaxy implementation of this tool.
+
+    ]]></help>
+    <citations>
+    </citations>
+</tool>