# HG changeset patch
# User iuc
# Date 1465308288 14400
# Node ID 13191d4914f71428aacfefd5e304a2b806257713
# Parent  dc480609d9c111f744e4d0e5f5f6d49c8b47f2b3
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift_dbnsfp commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31

diff -r dc480609d9c1 -r 13191d4914f7 repository_dependencies.xml
--- a/repository_dependencies.xml	Thu Jan 22 08:53:21 2015 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,4 +0,0 @@
-<?xml version="1.0"?>
-<repositories description="This requires the SnpEff dbnsfp datatype definitions.">
-  <repository changeset_revision="0c4372b93e85" name="snpsift_dbnsfp_datatypes" owner="iuc" toolshed="https://toolshed.g2.bx.psu.edu" />
-</repositories>
diff -r dc480609d9c1 -r 13191d4914f7 snpSift_dbnsfp.xml
--- a/snpSift_dbnsfp.xml	Thu Jan 22 08:53:21 2015 -0500
+++ b/snpSift_dbnsfp.xml	Tue Jun 07 10:04:48 2016 -0400
@@ -1,24 +1,27 @@
-<tool id="snpSift_dbnsfp" name="SnpSift dbNSFP" version="4.0.0">
-    <description>Add Annotations from dbNSFP</description>
-    <expand macro="requirements" />
+<tool id="snpSift_dbnsfp" name="SnpSift dbNSFP" version="@WRAPPER_VERSION@.0">
+    <description>Add Annotations from dbNSFP or similar annotation DBs</description>
     <macros>
         <import>snpSift_macros.xml</import>
     </macros>
-    <command>
-        java -Xmx6G -jar \$SNPEFF_JAR_PATH/SnpSift.jar dbnsfp -v
-        #if $db.dbsrc == 'cached' :
-          -db $db.dbnsfp 
-          #if $db.annotations and $db.annotations.__str__ != '':
+    <expand macro="requirements" />
+    <expand macro="stdio" />
+    <expand macro="version_command" />
+    <command><![CDATA[
+        java -Xmx6G -jar "\$SNPEFF_JAR_PATH/SnpSift.jar" dbnsfp -v
+        #if $db.dbsrc == 'cached':
+          -db "$db.dbnsfp"
+          #if $db.annotations and str($db.annotations) != '':
             -f "$db.annotations"
           #end if
-        #else :
+        #else:
           -db "${db.dbnsfpdb.extra_files_path}/${db.dbnsfpdb.metadata.bgzip}"
-          #if $db.annotations and $db.annotations.__str__ != '':
+          #if $db.annotations and str($db.annotations) != '':
             -f "$db.annotations"
           #end if
-        #end if          
-        $input > $output  
-        2> tmp.err &amp;&amp; grep -v file tmp.err
+        #end if
+        "$input" > "$output"
+        2> tmp.err && grep -v file tmp.err
+]]>
     </command>
     <inputs>
         <param name="input" type="data" format="vcf" label="Variant input file in VCF format"/>
@@ -29,17 +32,17 @@
             </param>
             <when value="cached">
                 <param name="dbnsfp" type="select" label="Genome">
-                    <options from_data_table="snpsift_dbnsfp">
-                        <column name="name" index="1"/>
-                        <column name="value" index="2"/>
+                    <options from_data_table="snpsift_dbnsfps">
+                        <column name="name" index="2"/>
+                        <column name="value" index="3"/>
                     </options>
                 </param>
                 <param name="annotations" type="select" multiple="true" display="checkboxes" label="Annotate with">
-                    <options from_data_table="snpsift_dbnsfp">
-                        <column name="name" index="3"/>
-                        <column name="value" index="3"/>
-                        <filter type="param_value" ref="dbnsfp" column="2" />
-                        <filter type="multiple_splitter" column="3" separator=","/>
+                    <options from_data_table="snpsift_dbnsfps">
+                        <column name="name" index="4"/>
+                        <column name="value" index="4"/>
+                        <filter type="param_value" ref="dbnsfp" column="3" />
+                        <filter type="multiple_splitter" column="4" separator=","/>
                     </options>
                 </param>
             </when>
@@ -53,7 +56,6 @@
             </when>
         </conditional>
     </inputs>
-    <expand macro="stdio" />
     <outputs>
         <data format="vcf" name="output" />
     </outputs>
@@ -70,9 +72,10 @@
             </output>
         </test>
     </tests>
-    <help>
+    <help><![CDATA[
 
 The dbNSFP is an integrated database of functional predictions from multiple algorithms (SIFT, Polyphen2, LRT and MutationTaster, PhyloP and GERP++, etc.).
+It contains variant annotations such as:
 
 
   1000Gp1_AC
@@ -124,7 +127,7 @@
   ESP6500_EA_AF
     Alternative allele frequency in the European American samples of the NHLBI GO Exome Sequencing Project (ESP6500 data set)
   FATHMM_pred
-    If a FATHMM_score is &lt;=-1.5 (or rankscore &lt;=0.81415) the corresponding non-synonymous SNP is predicted as "D(AMAGING)"; otherwise it is predicted as "T(OLERATED)". Multiple predictions separated by ";"
+    If a FATHMM_score is <=-1.5 (or rankscore <=0.81415) the corresponding non-synonymous SNP is predicted as "D(AMAGING)"; otherwise it is predicted as "T(OLERATED)". Multiple predictions separated by ";"
   FATHMM_rankscore
     FATHMMori scores were ranked among all FATHMMori scores in dbNSFP. The rankscore is the ratio of the rank of the score over the total number of FATHMMori scores in dbNSFP. If there are multiple scores, only the most damaging (largest) rankscore is presented. The scores range from 0 to 1
   FATHMM_score
@@ -152,7 +155,7 @@
   LRT_Omega
     Estimated nonsynonymous-to-synonymous-rate ratio (Omega, reported by LRT)
   LRT_converted_rankscore
-    LRTori scores were first converted as LRTnew=1-LRTori*0.5 if Omega&lt;1, or LRTnew=LRTori*0.5 if Omega&gt;=1. Then LRTnew scores were ranked among all LRTnew scores in dbNSFP. The rankscore is the ratio of the rank over the total number of the scores in dbNSFP. The scores range from 0.00166 to 0.85682
+    LRTori scores were first converted as LRTnew=1-LRTori*0.5 if Omega<1, or LRTnew=LRTori*0.5 if Omega>=1. Then LRTnew scores were ranked among all LRTnew scores in dbNSFP. The rankscore is the ratio of the rank over the total number of the scores in dbNSFP. The scores range from 0.00166 to 0.85682
   LRT_pred
     LRT prediction, D(eleterious), N(eutral) or U(nknown), which is not solely determined by the score
   LRT_score
@@ -222,7 +225,7 @@
   SIFT_converted_rankscore
     SIFTori scores were first converted to SIFTnew=1-SIFTori, then ranked among all SIFTnew scores in dbNSFP. The rankscore is the ratio of the rank the SIFTnew score over the total number of SIFTnew scores in dbNSFP. If there are multiple scores, only the most damaging (largest) rankscore is presented. The rankscores range from 0.02654 to 0.87932
   SIFT_pred
-    If SIFTori is smaller than 0.05 (rankscore&gt;0.55) the corresponding non-synonymous SNP is predicted as "D(amaging)"; otherwise it is predicted as "T(olerated)". Multiple predictions separated by ";"
+    If SIFTori is smaller than 0.05 (rankscore>0.55) the corresponding non-synonymous SNP is predicted as "D(amaging)"; otherwise it is predicted as "T(olerated)". Multiple predictions separated by ";"
   SIFT_score
     SIFT score (SIFTori). Scores range from 0 to 1. The smaller the score the more likely the SNP has damaging effect. Multiple scores separated by ";"
   SiPhy_29way_logOdds
@@ -241,7 +244,11 @@
     rs numbers from UniSNP, which is a cleaned version of dbSNP build 129, in format: rs number1;rs number2;...
 
 
-The website for  dbNSFP database is https://sites.google.com/site/jpopgen/dbNSFP  and there is only annotation for human hg18 and hg19 genome builds. 
+The website for  dbNSFP database is https://sites.google.com/site/jpopgen/dbNSFP and there is only annotation for human genome builds. 
+
+The procedure for preparing the dbNSFP data for use in SnpSift dbnsfp is in the SnpSift documentation:
+*( It also provides links for dbNSFP databases prebuilt for SnpSift )*
+http://snpeff.sourceforge.net/SnpSift.html#dbNSFP
 
 However, any dbNSFP-like tabular file that be can used with SnpSift dbnsfp if it has::
 
@@ -265,10 +272,9 @@
 	4	100239319	T	G	H	P	ADH1B	0
 
 
-The uploaded tabular file should be set to datatype: "dbnsfp.tabular"
-Using "Convert Format" the "dbnsfp.tabular" can be converted to the correct format for SnpSift dbnsfp.
-
-The procedure for preparing the dbNSFP data for use in SnpSift dbnsfp is in the SnpSift documentation.
+The galaxy datatypes for dbNSFP can automatically convert the specially formatted tabular file for use by SnpSift dbNSFP:
+  1. Upload the tabular file, set the datatype as: **"dbnsfp.tabular"**
+  2. Edit the history dataset attributes (pencil icon): Use "Convert Format" to convert the **"dbnsfp.tabular"** to the correct format for SnpSift dbnsfp: **"snpsiftdbnsfp"**.
 
 
 @EXTERNAL_DOCUMENTATION@
@@ -276,6 +282,14 @@
 
 @CITATION_SECTION@
 
-
+]]>
     </help>
+    <expand macro="citations">
+        <citation type="doi">DOI: 10.1002/humu.21517</citation>
+        <citation type="doi">DOI: 10.1002/humu.22376</citation>
+        <citation type="doi">DOI: 10.1002/humu.22932</citation>
+        <citation type="doi">doi: 10.1093/hmg/ddu733</citation>
+        <citation type="doi">doi: 10.1093/nar/gku1206</citation>
+        <citation type="doi">doi: 10.3389/fgene.2012.00035</citation>
+    </expand>
 </tool>
diff -r dc480609d9c1 -r 13191d4914f7 snpSift_macros.xml
--- a/snpSift_macros.xml	Thu Jan 22 08:53:21 2015 -0500
+++ b/snpSift_macros.xml	Tue Jun 07 10:04:48 2016 -0400
@@ -1,7 +1,7 @@
 <macros>
     <xml name="requirements">
         <requirements>
-            <requirement type="package" version="4.0">snpEff</requirement>
+            <requirement type="package" version="4.1">snpEff</requirement>
         </requirements>
     </xml>
   <xml name="stdio">
@@ -10,6 +10,10 @@
         <exit_code range="1:"  level="fatal" description="Error" />
     </stdio>
   </xml>
+  <xml name="version_command">
+    <version_command>java -jar "$SNPEFF_JAR_PATH/snpEff.jar" -version</version_command>
+  </xml>
+  <token name="@WRAPPER_VERSION@">4.1</token>
   <token name="@EXTERNAL_DOCUMENTATION@">
 
 For details about this tool, please go to:
diff -r dc480609d9c1 -r 13191d4914f7 tool-data/snpsift_dbnsfps.loc.sample
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tool-data/snpsift_dbnsfps.loc.sample	Tue Jun 07 10:04:48 2016 -0400
@@ -0,0 +1,3 @@
+#key	build	description	path	annotations
+#GRCh37_dbNSFP2.4	GRCh37	GRCh37 dbNSFP2.4	/depot/snpeff/dbNSFP2.4.txt.gz	SIFT_pred,Uniprot_acc
+#GRCh38_dbNSFP3.1c	GRCh38	GRCh38 dbNSFP3.1c	/depot/snpeff/dbNSFP3.1c.txt.gz	SIFT_pred,Uniprot_acc
diff -r dc480609d9c1 -r 13191d4914f7 tool_data_table_conf.xml.sample
--- a/tool_data_table_conf.xml.sample	Thu Jan 22 08:53:21 2015 -0500
+++ b/tool_data_table_conf.xml.sample	Tue Jun 07 10:04:48 2016 -0400
@@ -1,7 +1,7 @@
 <tables>
-    <table name="snpsift_dbnsfp" comment_char="#">
-        <columns>dbkey, name, value, annotations</columns>
-        <file path="tool-data/snpsift_dbnsfp.loc" />
+    <table name="snpsift_dbnsfps" comment_char="#">
+        <columns>key, build, name, value, annotations</columns>
+        <file path="tool-data/snpsift_dbnsfps.loc" />
     </table>
 </tables>
 
diff -r dc480609d9c1 -r 13191d4914f7 tool_dependencies.xml
--- a/tool_dependencies.xml	Thu Jan 22 08:53:21 2015 -0500
+++ b/tool_dependencies.xml	Tue Jun 07 10:04:48 2016 -0400
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <tool_dependency>
-  <package name="snpEff" version="4.0">
-      <repository changeset_revision="6bc55957927b" name="package_snpeff_4_0" owner="iuc" toolshed="https://toolshed.g2.bx.psu.edu" />
+    <package name="snpEff" version="4.1">
+        <repository changeset_revision="374c7f8421fb" name="package_snpeff_4_1" owner="iuc" toolshed="https://toolshed.g2.bx.psu.edu" />
     </package>
 </tool_dependency>