diff proteore_get_unique_peptide_SRM-MRM_method.xml @ 0:a2b06836de90 draft

planemo upload commit f9de6f4e3302c41e64c39d639bee780e5eafd84d-dirty
author proteore
date Fri, 12 Jul 2019 07:49:45 -0400
parents
children b72ece649392
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/proteore_get_unique_peptide_SRM-MRM_method.xml	Fri Jul 12 07:49:45 2019 -0400
@@ -0,0 +1,154 @@
+<tool id="proteore_get_unique_peptide_srm_method" name="Get unique peptide SRM-MRM method" version="2019.07.11">
+    <description>[SRM Atlas]</description>
+    <requirements>
+    </requirements>
+    <command detect_errors="exit_code"><![CDATA[
+
+        python $__tool_directory__/get_unique_srm.py 
+        
+        #if $input.ids == "text"
+            --input="$input.txt"
+            --input_type="list"
+        #else
+            --input="$input.input_file"
+            --column_number="$input.ncol"
+            --header="$input.header"
+            --input_type="file"
+        #end if
+
+        --features="$protein_features"
+        --output="$output"
+        
+        #if "SRM_atlas" in str($srm_file).split("/")
+            --ref_file="$srm_file"
+        #else 
+            --ref_file="$__tool_directory__/$srm_file"
+        #end if 
+
+    ]]></command>
+    <inputs>
+    <conditional name="input" >
+        <param name="ids" type="select" label="Enter IDs (Uniprot Accession number, e.g. P04746)" help="Copy/paste or from a file (e.g. table)" >
+            <option value="text">Copy/paste your Uniprot-AC identifiers</option>
+            <option value="file" selected="true">Input file containing Uniprot-AC identifiers</option>
+        </param>
+        <when value="text" >
+            <param name="txt" type="text" label="Copy/paste IDs" help='IDs must be separated by tab, space or carriage return into the form field, for example: P31946 P62258' >
+                <sanitizer invalid_char="">
+                    <valid initial="string.printable">
+                        <remove value="&apos;"/>
+                    </valid>
+                    <mapping initial="none">
+                        <add source="&apos;" target="__sq__"/>
+                        <add source="&#x20;" target=""/>
+                        <add source="&#xA;" target=""/>
+                        <add source="&#xD;" target=""/>
+                        <add source="&#x9;" target=""/>
+                    </mapping>
+                </sanitizer>
+            </param>
+        </when>
+        <when value="file" >
+            <param name="input_file" type="data" format="txt,tabular" label="Select your file" help="" />
+            <param name="header" type="boolean" checked="true" truevalue="true" falsevalue="false" label="Does file contain header?" />
+            <param name="ncol" type="text" value="c1" label="Column number of IDs" help='For example, fill in "c1" if it is the first column, "c2" if it is the second column and so on'>
+                <validator type="regex" message="Please enter a column number, for example: 'c1' for the first column">[c]{0,1}[0-9]+</validator>
+            </param>
+        </when>
+    </conditional>
+    <param name="srm_file" type="select" label="Release" >
+        <options from_data_table="proteore_human_srm_atlas">
+            <filter type="sort_by" column="0"/>
+        </options>
+    </param>
+    <param name="protein_features" type="select" label="Peptide sequence/features" multiple="true" help="" display="checkboxes" optional="false">
+        <option value="PeptideSeq" selected="true">Peptide sequence</option>
+        <option value="SSRT" selected="false">SSRT (Sequence Specific Retention Time)</option>
+        <option value="Length" selected="false">Length (peptide sequence length)</option>
+        <option value="MW" selected="false">MW (Molecular weight)</option>
+        <option value="PA_AccNum" selected="false">PeptideAtlas Accession (PA_Acc)</option>
+    </param>
+    </inputs>
+    <outputs>
+        <data name="output" format="tsv"/>
+    </outputs>
+    <tests>
+        <test>
+            <conditional name="input" >
+                <param name="ids" value="file"/>
+                <param name="input_file" value="Lacombe_et_al_2017_modified.tsv" />
+                <param name="header" value="true" />
+                <param name="ncol" value="c1"/>
+            </conditional>
+            <param name="srm_file" value="tool-data/Human_SRM_atlas_2016-04.csv" />
+            <param name="protein_features" value="PeptideSeq,SSRT,Length,MW,PA_AccNum"/>
+            <output name="output" value="srm_results.tsv" />
+        </test>
+    </tests>
+    <help><![CDATA[
+        **Description**
+
+This tool allows to retrieve unique proteotypic peptide and related information (from SRMAtlas) 
+for building Selected Reaction Monitoring (SRM) method using a list of Uniprot accession number as input. 
+The SRMAtlas is a compendium of targeted proteomics assays resulting from high-quality measurements of natural 
+and synthetic peptides conducted on a triple quadrupole mass spectrometer, and is intended as a resource 
+for building selected/multiple reaction monitoring (SRM/MRM)-based proteomic methods.
+
+-----
+
+**Input**
+
+A list of IDs (entered in a copy/paste mode) or a single-column file, the tool will then return a file containing 
+the selected information (peptide sequence/features). If your input is a multiple-column file, the column(s) 
+containing the selected information will be added at the end of the input file. Only Uniprot accession number (e.g. P31946) are allowed. 
+If your list of IDs is not in this form, please use the ID_Converter tool of ProteoRE.
+
+.. class:: warningmark
+
+Accession numbers with an hyphen ("-") that normally correspond to isoform are not considered as similar to its canonical form.
+
+.. class:: warningmark
+
+In copy/paste mode, the number of IDs considered in input is limited to 5000.
+
+-----
+
+**Parameters**
+
+Release: choose the release you want to use for retrieving peptide sequences/features
+Peptide sequence/features: select peptide features you want to retrieve; Peptide sequence 
+(amino acid sequence of detected peptide, including any mass modifications); 
+SSRT (Sequence Specific Retention Time provides a hydrophobicity measure for each peptide using 
+the algorithm of Krohkin et al. SSRCalc); Length (peptide sequence length); MW (molecular weight); 
+PeptideAtlas Accession (PA_Acc).
+
+-----
+
+**Output**
+
+A text file containing the selected peptide features (in addition to the original column(s) provided). 
+Please, note that a "NA" is returned when there is no match between a source ID and SRM/MRM source file.
+
+-----
+
+**Data sources (release date)**
+
+This tool is using the following source file:
+
+- `HumanSRMAtlasPeptidesFinalAnnotated (2016-04) (Kusebauch et al., 2016, PMID: 27453469) <http://www.srmatlas.org/downloads/HumanSRMAtlasPeptidesFinalAnnotated.xlsx>`_.
+
+-----
+
+.. class:: infomark
+
+**Authors**
+
+David Christiany, 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, FR
+
+This work has been partially funded through the French National Agency for Research (ANR) IFB project.
+
+Help: contact@proteore.org for any questions or concerns about this tool.
+    ]]></help>
+</tool>
\ No newline at end of file